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 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.

cluster_id

Yes

Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI.

node_id

Yes

Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI.

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 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.

Example request:

N/A

Response

Response parameters:

Table 4 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 object

Node's metadata, which is a collection of attributes.

spec

spec object

Detailed description of the node targeted by this API. CCE creates or updates objects by defining or updating its spec.

status

status 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 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.

az

String

AZ of the node.

os

String

Node OS.

  • Nodes in clusters of Kubernetes v1.13, v1.15, v1.17, v1.19, v1.21, v1.23, or v1.25 support EulerOS 2.5.

  • Nodes in clusters of Kubernetes v1.19 or later support EulerOS 2.9.

  • Nodes in clusters of Kubernetes v1.25 or later support Ubuntu 22.04.

  • Nodes in clusters of Kubernetes v1.27 or later support HCE OS 2.0.

login

login object

Node login mode, which can only be key pair.

rootVolume

Volume object

System disk parameters of the node.

dataVolumes

Array of Volume object

Data disk parameters of the node.

storage

Storage object

Disk initialization management parameter.

This parameter is complex to configure. For details, see Attaching Disks to a Node.

If this parameter retains its default, disks are managed based on the DockerLVMConfigOverride (discarded) parameter in extendParam. This parameter is supported by clusters of version 1.15.11 and later.

Note

If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions.

publicIP

publicIP object

EIP parameters of a node.

nodeNicSpec

nodeNicSpec 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.

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 object

Container runtime. The default value is docker.

extendParam

extendParam object

Extended parameter. Format: Key-value pair.

Table 8 Data structure of the nodeNicSpec field

Parameter

Type

Description

primaryNic

primaryNic object

Description about the primary NIC.

extNics

Array of extNics 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 configuration item. (This parameter has been discarded. Use the storage field instead.) 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.

Table 13 Storage

Parameter

Type

Description

storageSelectors

Array of StorageSelectors objects

Disk selection. Matched disks are managed according to matchLabels and storageType.

storageGroups

Array of StorageGroups objects

A storage group consists of multiple storage devices. It is used to divide storage space.

Table 14 StorageSelectors

Parameter

Type

Description

name

String

Selector name, used as the index of selectorNames in storageGroup. Therefore, the name of each selector must be unique.

storageType

String

Specifies the storage type. Currently, only evs (EVS volumes) and local (local volumes) are supported. The local storage does not support disk selection. All local disks will form a VG. Therefore, only one storageSelector of the local type is allowed.

matchLabels

matchLabels object

Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported.

Table 15 matchLabels

Parameter

Type

Description

size

String

Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100

volumeType

String

EVS disk type. Currently, SSD, GPSSD and SAS are supported.

metadataEncrypted

String

Disk encryption identifier. 0 indicates that the disk is not encrypted, and 1 indicates that the disk is encrypted.

metadataCmkid

String

Customer master key ID of an encrypted disk. The value is a 36-byte string.

count

String

Number of disks to be selected. If this parameter is left blank, all disks of this type are selected.

Table 16 StorageGroups

Parameter

Type

Description

name

String

Name of a virtual storage group, which must be unique.

cceManaged

Boolean

Storage space for Kubernetes and runtime components. Only one group can be set to true. If this parameter is left blank, the default value false is used.

selectorNames

Array of strings

This parameter corresponds to name in storageSelectors. A group can match multiple selectors, but a selector can match only one group.

virtualSpaces

Array of VirtualSpace objects

Detailed management of space configuration in a group.

Table 17 VirtualSpace

Parameter

Type

Description

name

String

Name of a virtualSpace.

  • Kubernetes: Kubernetes space configuration. lvmConfig needs to be configured.

  • runtime: runtime space configuration. runtimeConfig needs to be configured.

  • user: user space configuration. lvmConfig needs to be configured.

size

String

Size of a virtualSpace. The value must be an integer in percentage. Example: 90%.

Note

The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.

lvmConfig

LVMConfig object

LVM configurations, applicable to kubernetes and user spaces. Note that one virtual space supports only one config.

runtimeConfig

RuntimeConfig object

runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config.

Table 18 LVMConfig

Parameter

Type

Description

lvType

String

LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.

path

String

Path to which the disk is attached. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed.

Table 19 RuntimeConfig

Parameter

Type

Description

lvType

String

LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.

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": "#s1.medium#EulerOS 2.5"
    }
  },
  "spec": {
    "flavor": "s1.medium",
    "az": "",
    "os": "EulerOS 2.5",
    "login": {
      "sshKey": "Keypair-demo"
    },
    "rootVolume": {
      "volumetype": "SAS",
      "size": 40
    },
    "dataVolumes": [
      {
        "volumetype": "SAS",
        "size": 100
      }
    ],
    "storage": {
        "storageSelectors": [
            {
                "name": "cceUse",
                "storageType": "evs",
                "matchLabels": {
                    "size": "100",
                    "volumeType": "SAS",
                    "count": "1"
                }
            }
        ],
        "storageGroups": [
            {
                "name": "vgpaas",
                "selectorNames": [
                    "cceUse"
                ],
                "cceManaged": true,
                "virtualSpaces": [
                    {
                        "name": "runtime",
                        "size": "90%"
                    },
                    {
                        "name": "kubernetes",
                        "size": "10%"
                    }
                ]
            }
        ]
    },
    "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 20 describes the status code of this API.

Table 20 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.