A200161411/cloud-container-engine
1
0
Fork 0
forked from docs/cloud-container-engine
Code Pull Requests Activity
cloud-container-engine/api-ref/source/apis/cluster_management/reading_a_specified_node.rst
proposalbot 2490522af3 Changes to cce_api-ref from docs/doc-exports#318 (CCE API for v1.23 
CCE API for

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2022-11-10 10:54:32 +00:00

58 KiB
Raw Blame History

original_name

cce_02_0243.html

Reading a Specified Node

Function

This API is used to obtain details about a node with a specified node ID.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/{node_id}

Table 1 <cce_02_0243__table2027961241820> describes the parameters of the API.

Table 1 Parameter description
Parameter Mandatory Description
project_id Yes Project ID. For details about how to obtain the project ID, see How to Obtain Parameters in the API URI <cce_02_0271>.
cluster_id Yes Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI <cce_02_0271>.
node_id Yes Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI <cce_02_0271>.
Table 2 Query parameters
Parameter Mandatory Type Description
errorStatus No String

This field allows a cluster to be in the Error state if exceptions occur when the cluster is being deleted. If the value of errorStatus is null, the cluster stays in the Deleting state, but not Error.

Minimum: 0

Maximum: 10

Request

Request parameters:

Table 3 <cce_02_0243__table13638079467> describes the request parameters.

Table 3 Parameters in the request header
Parameter Mandatory Description
Content-Type Yes

Message body type (format). Possible values:

  • application/json;charset=utf-8
  • application/json
X-Auth-Token Yes Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details on how to obtain a user token, see API Usage Guidelines <cce_02_0344>.

Example request:

N/A

Response

Response parameters:

Table 4 <cce_02_0243__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242> describes the response parameters.

Table 4 Response parameters
Parameter Type Description
kind String API type. The value is fixed at Node and cannot be changed.
apiVersion String API version. The value is fixed at v3 and cannot be changed.
metadata metadata <cce_02_0243__table669019286188> object Node's metadata, which is a collection of attributes.
spec spec <cce_02_0243__table13949117115810> object Detailed description of the node targeted by this API. CCE creates or updates objects by defining or updating its spec.
status status <cce_02_0243__table1741714540447> object Node status and jobID of the node creation job.
Table 5 Data structure of the metadata field
Parameter Type Description
name String

Node name.

Note

Enter 1 to 56 characters, starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.

Minimum: 1

Maximum: 56
uid String Node ID, which is unique and automatically generated after the resource is created. A user-defined ID will not take effect.
labels Map<String,String>

CCE node label (not the native Kubernetes label).

Labels are used to select objects that meet certain criteria. A label is a key-value pair.

Example:

"labels": {
 "key" : "value"
}
creationTimestamp String Time when the object was created. The value is automatically generated after the object is created. A user-defined value will not take effect.
updateTimestamp String Time when the object was updated. The value is automatically generated after the object is created. A user-defined value will not take effect.
annotations annotations <cce_02_0243__table10411172218590> object Node annotation. Format: Key-value pair.
Table 6 Data structure of the annotations field
Parameter Type Description
kubernetes.io/node-pool.id String
  • If a node is created from a node pool, the value is the ID of the node pool.
  • If the node is not created from a node pool, the value is in the following format: Name of the AZ where the node is located#Node flavor#Node OS name
Table 7 Data structure of the spec field
Parameter Type Description
flavor String Node specifications. For details, see the description of the flavorRef parameter in Creating an ECS.
az String AZ of the node. For details, see the description of the availability_zone parameter in Creating an ECS.
os String

Node OS.

  • Nodes in clusters of Kubernetes v1.11 or earlier support EulerOS 2.2.
  • Nodes in clusters of Kubernetes v1.13 or v1.15 support EulerOS 2.5.
  • Nodes in clusters of Kubernetes v1.17 support EulerOS 2.5 and CentOS 7.7.
  • Nodes in clusters of Kubernetes v1.19, v1.21 or v1.23 support EulerOS 2.5, EulerOS 2.9 and CentOS 7.7.
  • Nodes using kata runtime in CCE Turbo cluster support EulerOS 2.9.
login login <cce_02_0242__table10946114617286> object Node login mode, which can only be key pair.
rootVolume Volume <cce_02_0242__table1359314517> object System disk parameters of the node.
dataVolumes Array of Volume <cce_02_0242__table1359314517> object Data disk parameters of the node.
publicIP publicIP <cce_02_0242__table139179586343> object EIP parameters of a node.
nodeNicSpec nodeNicSpec <cce_02_0243__table162751117166> object Description about the node NIC.
count Integer

Number of nodes to be created in a batch. The value must be a positive integer greater than or equal to 1.

Note

This parameter can be set to 0 for a node pool.
billingMode Integer

Billing mode of a node.

Note

This field is not supported for the current version.
ecsGroupId String

ECS group ID. If this parameter is specified, the node is created in the specified ECS group.

Note

This parameter is not supported when you add a node to a node pool or use CCE Turbo cluster.
dedicatedHostId String

ID of the DeH host. If this parameter is specified, the node is scheduled to its own DeH host.

Note

This parameter is not supported when you add a node to a node pool.
offloadNode Boolean

Whether the node belongs to a CCE Turbo cluster.

Note

This parameter is not supported when you add a node to a node pool.
faultDomain String

Cloud server fault domain. The node is created in the fault domain specified by this parameter.

Note

You must specify the ECS to which the fault domain policy applies and enable the fault domain feature.
runtime Runtime <cce_02_0243__table483064395515> object Container runtime. The default value is docker.
extendParam extendParam <cce_02_0243__table2039318361484> object Extended parameter. Format: Key-value pair.
Table 8 Data structure of the nodeNicSpec field
Parameter Type Description
primaryNic primaryNic <cce_02_0243__table614985275016> object Description about the primary NIC.
extNics Array of extNics <cce_02_0243__table614985275016> objects Extension NIC.
Table 9 Data structure of the primaryNic/extNics field
Parameter Type Description
subnetId String Network ID of the subnet to which the NIC belongs.
fixedIps Array of strings The IP address of the primary NIC is specified by fixedIps. The number of IP addresses cannot be greater than the number of created nodes. fixedIps and ipBlock cannot be specified at the same time.
ipBlock String CIDR format of the IP address segment. The IP address of the created node falls in this IP address segment. fixedIps and ipBlock cannot be specified at the same time.
Table 10 Runtime
Parameter Type Description
name String

Container runtime. The default value is docker.

Enumeration values:

  • docker
  • containerd
Table 11 Data structure of the extendParam field
Parameter Type Description
chargingMode Integer

Billing mode of a node.

Note

This field is not supported for the current version.
ecs:performancetype String Type of the ECS specifications.
orderID String

Order ID.

Note

This field is not supported for the current version.
productID String

Product ID.

Note

This field is not supported for the current version.
maxPods Integer Maximum number of pods on the node.
dockerBaseSize Integer Available disk space of a single Docker container on the node using the device mapper.
periodType String

Purchase duration type.

Note

This field is not supported for the current version.
periodNum Integer

Purchase duration.

Note

This field is not supported for the current version.
isAutoRenew String

Whether auto renewal is enabled.

  • true: Indicates that auto renewal is enabled.
  • false: Indicates that auto renewal is disabled.

Note

This field is not supported for the current version.
DockerLVMConfigOverride String

Docker data disk configurations. The following is the default configuration:

"DockerLVMConfigOverride":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"

The configuration contains the following fields:

  • userLV: size of the user space, for example: vgpaas/20%VG.
  • userPath: mount path of the user space, for example: /home/wqt-test.
  • diskType: disk type. Currently, only the evs, hdd, and ssd are supported.
  • lvType: type of a logic volume. Currently, the value can be linear or striped.
  • dockerThinpool: Docker disk space, for example: vgpaas/60%VG.
  • kubernetesLV: kubelet size, for example: vgpaas/20%VG.
Table 12 Data structure of the status field
Parameter Type Description
phase String

Node status.

  • Build: The VM that hosts the node is being created.
  • Active: The node is ready for use.
  • Abnormal: The node is unready for use.
  • Deleting: The node is being deleted.
  • Installing: The node is being installed.
  • Upgrading: The node is being upgraded.
serverId String ID of the ECS where the node resides.
publicIP String EIP used by the node to access public networks.
privateIP String Private IP address used by the node to communicate with other nodes in the same VPC as the current cluster.

Example response:

{
  "kind": "Node",
  "apiVersion": "v3",
  "metadata": {
    "name": "myhost",
    "uid": "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
    "creationTimestamp": "2020-02-02 08:12:40.124294439 +0000 UTC",
    "updateTimestamp": "2020-02-02 08:18:20.221871842 +0000 UTC",
    "annotations": {
      "kubernetes.io/node-pool.id": "eu-de-01#s1.medium#EulerOS 2.5"
    }
  },
  "spec": {
    "flavor": "s1.medium",
    "az": "eu-de-01",
    "os": "EulerOS 2.5",
    "login": {
      "sshKey": "Keypair-demo"
    },
    "rootVolume": {
      "volumetype": "SAS",
      "size": 40
    },
    "dataVolumes": [
      {
        "volumetype": "SAS",
        "size": 100
      }
    ],
    "publicIP": {
      "eip": {
        "bandwidth": {}
      }
    }
  },
  "status": {
    "phase": "Active",
    "serverId": "456789abc-9368-46f3-8f29-d1a95622a568",
    "publicIP": "10.34.56.78",
    "privateIP": "192.168.1.23"
  }
}

Status Code

Table 13 <cce_02_0243__en-us_topic_0079614900_table46761928> describes the status code of this API.

Table 13 Status code
Status Code Description
200 Information about the node in the specified cluster is successfully obtained.

For details about error status codes, see Status Code <cce_02_0084>.