Reading a Specified Node

project_id

Yes

String

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

cluster_id

Yes

String

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

node_id

Yes

String

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

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

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, see Obtaining a User Token.

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

NodeMetadata object

Node metadata, which is a collection of attributes.

spec

NodeSpec object

Detailed description of the node. CCE creates or updates objects by defining or updating spec.

status

NodeStatus object

Node status, which is dynamically recorded. A user-defined value will not function when a node is being created or modified.

name

String

Node name

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"
}

annotations

Map<String,String>

CCE node annotations, in key-value pairs (not the native Kubernetes annotations).

Example:

"annotations": {
  "key1" : "value1",
  "key2" : "value2"
}

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.

ownerReference

ownerReference object

Owner object

nodepoolName

String

Node pool name

nodepoolID

String

Node pool UID

flavor

String

Node specifications. For details about the node specifications supported by CCE, see Node Flavor Description.

az

String

AZ where the node to be created is located. You need to specify the AZ name. If it is set to random, the node will be created in a random AZ.

For details about AZs supported by CCE, see Regions and Endpoints.

os

String

Node OS. For details about the supported OSs, see Node OS.

login

Login object

Node login mode. Either the key pair or password must be used for login.

rootVolume

Volume object

Information about disks on the node

dataVolumes

Array of Volume objects

Data disk parameters of a node. A VM can have up to 16 disks attached, while a BMS can only have up to 10 disks attached. The maximum number of disks that can be attached to either a VM or BMS is limited by their respective maximum disk limits. (You can add a second data disk for each of your nodes through the CCE console or API.)

The data disk used by the container runtime and kubelet cannot be uninstalled, or the node will become unavailable.

For DeC nodes, the parameter details are the same as those for rootVolume.

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.

publicIP

NodePublicIP object

EIP of a node.

nodeNicSpec

NodeNicSpec object

NIC of the node

count

Integer

Number of nodes to be created in a batch. The value must be a positive integer greater than or equal to 1 and less than or equal to the defined limit. This parameter can be left blank when it is used for a node pool.

billingMode

Integer

Node billing mode.

• 0: pay-per-use

• 1: yearly/monthly

• 2: (discarded) yearly/monthly billing with auto payment enabled

taints

Array of Taint objects

You can add taints to created nodes to configure anti-affinity. A maximum of 20 taints can be added. Each taint contains the following parameters:

• Key: A key must contain 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain name can be used as the prefix of a key.

• Value: A value must start with a letter or digit and can contain a maximum of 63 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

• Effect: Available options are NoSchedule, PreferNoSchedule, and NoExecute.

  When creating a node, you can specify the initial value for this parameter and this field is not returned during query. In using node pools, the initial value can be specified in the node template and this field is returned during query. In other scenarios, this field is not returned during query.

Example:

"taints": [{
  "key": "status",
  "value": "unavailable",
  "effect": "NoSchedule"
}, {
  "key": "looks",
  "value": "bad",
  "effect": "NoSchedule"
}]

k8sTags

Map<String,String>

Defined in key-value pairs. A maximum of 20 key-value pairs are allowed.

• Key: Enter 1 to 63 characters, starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key and contain a maximum of 253 characters. Example DNS subdomain: example.com/my-key

• Value: The value can be left blank or contain 1 to 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string.

  When creating a node, you can specify the initial value for this parameter and this field is not returned during query. In using node pools, the initial value can be specified in the node template and this field is returned during query. In other scenarios, this field is not returned during query.

Example:

"k8sTags": {
  "key": "value"
}

ecsGroupId

String

ECS group ID. If this parameter is configured, nodes will be created in the specified ECS group.

dedicatedHostId

String

ID of the DeH to which the node is scheduled.

userTags

Array of UserTag objects

Cloud server tag. The key of a tag must be unique. The maximum number of custom tags supported by CCE depends on the region and cannot exceed 8.

When creating a node, you can specify the initial value for this parameter and this field is not returned during query. In using node pools, the initial value can be specified in the node template and this field is returned during query. In other scenarios, this field is not returned during query.

runtime

Runtime object

Container runtime:

• Clusters of v1.25 or earlier: docker.

• Clusters of v1.25 or later: Container runtime varies with the OS. For nodes running EulerOS 2.5 or EulerOS 2.8, the default container runtime is docker. For nodes running other OSs, the default container runtime is containerd.

initializedConditions

Array of strings

Custom initialization flag, which is left blank by default.

Before CCE nodes are initialized, node.cloudprovider.kubernetes.io/uninitialized is added to the nodes to prevent pods from being scheduled to these nodes. When creating a node, you can configure the initializedConditions parameter to control the taint removal time. By default, the timeout period is not configured.

Example:

1. Create a node and add parameter "initializedConditions": ["CCEInitial", "CustomedInitial"].

2. After custom initialization is complete, CCE will call a Kubernetes API (for example, PATCH /v1/nodes/{node_ip}/status) to update the node conditions by adding two labels of types CCEInitial and CustomedInitial and setting the status to True, as shown in the following:

status:
  conditions:
  - type: CCEInitial
    status: 'True'
  - type: CustomedInitial
    status: 'True'

1. CCE polls status.Conditions of nodes to check whether there are conditions of types CCEInitial and CustomedInitial. If such conditions exist and the status is True, the node initialization is complete and the initialization taint is removed.

2. initializedConditions allows you to configure a timeout period during node creation. For example, "initializedConditions": ["CCEInitial:15m", "CustomedInitial:15m"] indicates that the timeout period is 15 minutes. After the timeout period is reached, the initialization conditions will be automatically ignored and the initialization taint will be removed when CCE polls the node.

• Use only letters and digits. Max. characters: 20.

• Max. flags: 2.

• The unit of the timeout period is minute (m).

extendParam

NodeExtendParam object

Extended parameters for creating a node.

hostnameConfig

HostnameConfig object

Kubernetes node name configuration parameter, which is supported by clusters of v1.23.6-r0 to v1.25 or clusters of v1.25.2-r0 or later versions.

serverEnterpriseProjectID

String

Enterprise project ID of a server. CCE does not support features provided by EPS. This field is used only for synchronizing enterprise project IDs of servers.

To create a node or node pool, you can specify an existing enterprise project for it. If this field is left blank, it inherits the enterprise project attributes of the cluster that runs the node or node pool.

When updating a node pool, any configuration modifications you made will apply only to new nodes. You need to modify the enterprise projects of existing nodes on the EPS console.

If no value is specified during the update, this field will not be updated.

If this parameter is left blank, the cluster enterprise project is returned.

sshKey

String

Name of the key pair used for login.

userPassword

UserPassword object

Password used for node login.

username

String

Login account. The default value is root.

password

String

If a username and a password are used to create a node, this field is shielded in the response body.

A password must meet the following complexity requirements:

• Contains 8 to 26 characters.

• Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*)

• Cannot contain the username or the username spelled backwards.

  The password field must be salted during node creation. For details, see Adding a Salt in the password Field When Creating a Node.

size

Integer

Disk size, in GB.

• Value range for system disks: 40 to 1024

• Value range for the first data disk: 20 to 32768 (When storage is not specified, this value range becomes 100 to 32768.)

• Value range for other data disks: 10 to 32768. (When storage is not specified, this value range becomes 100 to 32768.)

volumetype

String

Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS.

• SAS: high I/O SAS disk

• SSD: ultra-high I/O SSD disk

• SATA: common I/O SATA disk SATA disks have been removed from EVS. You can find them attached only on existing nodes.

extendParam

Map<String,Object>

Extended disk parameters, defined in extendparam in the API used to create an ECS.

For details, see Creating an ECS.

cluster_id

String

ID of the storage pool used by the ECS system disk. This field is used only for DeC clusters, which functions as dssPoolID, that is, the ID of the DSS storage pool.

To obtain the value, see the ID field in the API used to obtain details of a DSS storage pool.

cluster_type

String

Storage class of the cloud server system disk. The value is always dss. This field is used only for DeC clusters.

hw:passthrough

Boolean

• Pay attention to this field if your ECS is SDI-compliant. If the value of this field is true, an SCSI disk will be created.

• If the node pool type is ElasticBMS, this field must be set to true.

• If a node specification involves local disks and EVS disks at the same time, set the disk initialization parameters. For details, see Attaching Disks to a Node.

metadata

VolumeMetadata object

EVS disk encryption information. This field is mandatory only when you need to encrypt the system disk or data disks of the node to be created.

__system__encrypted

String

Whether the EVS disk is encrypted. The value 0 indicates that the EVS disk is not encrypted, and the value 1 indicates that the EVS disk is encrypted.

If this parameter is not specified, EVS disks will not be encrypted by default.

__system__cmkid

String

CMK ID, which indicates encryption in metadata. This field is used with __system__encrypted.

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.

name

String

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

storageType

String

Storage type. Only evs (EVS disks) and local (local disks) are supported. The local storage does not support disk selection. All local disks will form a VG, so 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.

size

String

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

volumeType

String

EVS disk type. SSD, GPSSD, SAS, ESSD, and SATA are supported. If this parameter is left blank, there is no restriction on the disk type.

metadataEncrypted

String

Disk encryption identifier. If this parameter is set to 0, it specifies that the disk is not encrypted. If this parameter is set to 1, it specifies that the disk is encrypted. If this parameter is left blank, there is no restriction on the disk encryption identifier.

metadataCmkid

String

CMK ID of an encrypted disk. The value is a string of 36 bytes. If this parameter is left blank, there is no restriction on the disk key ID.

count

String

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

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

Corresponds to name in storageSelectors. One group can select multiple selectors, but one selector can be selected by only one group.

virtualSpaces

Array of VirtualSpace objects

Detailed management of space configuration in a group.

name

String

Name of a virtualSpace. Options: share, kubernetes, runtime, and user

• share: shared space configuration (with the runtime and Kubernetes partitions cancelled). lvmConfig needs to be configured.

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

lvmConfig

LVMConfig object

LVM configuration managements, applicable to the share*, 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.

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.

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.

ids

Array of strings

IDs of existing EIPs. The quantity cannot be greater than the number of nodes to be created.

count

Integer

Number of EIPs to be dynamically created.

eip

NodeEIPSpec object

EIP configuration.

iptype

String

EIP type, specified in publicip.type in the API for assigning an EIP.

For details, see Assigning an EIP.

bandwidth

NodeBandwidth object

Bandwidth parameters of the EIP

chargemode

String

Bandwidth billing mode.

• If this field is not specified, the billing is based on bandwidth.

• If the field is null, the billing is based on bandwidth.

• If the field value is traffic, the billing is based on traffic.

• If the value is out of the preceding options, the cloud server will fail to be created.

size

Integer

Bandwidth size, specified in bandwidth.size in the API for assigning an EIP.

For details, see Assigning an EIP.

sharetype

String

Bandwidth sharing type. Value options: PER (exclusive bandwidth)

primaryNic

NicSpec object

Description of the primary NIC.

extNics

Array of NicSpec objects

Extension NIC

subnetId

String

Network ID of the subnet to which a NIC belongs. If subnetId is not specified when a primary NIC is creating, the cluster subnet will be used. If subnetList is also configured for a node pool, the subnetList field is used for adding subnets to the node pool. When creating an extension NIC, you must specify subnetId.

fixedIps

Array of strings

The IP address of the primary ENI is specified using fixedIps. The number of IP addresses cannot be greater than the number of created nodes. Either fixedIps or ipBlock can be specified. fiexdIps cannot be specified for extension ENIs.

ipBlock

String

CIDR format of the primary NIC IP range. The IP address of the created node falls in this range. fixedIps and ipBlock cannot be specified at the same time.

key

String

Key.

value

String

Value.

effect

String

Effect.

key

String

Key of the cloud server label. The value cannot start with CCE- or __type_baremetal.

value

String

Value of the cloud server label.

name

String

Container runtime. Default value:

• Clusters earlier than v1.25: The default value is docker.

• Clusters of v1.25 or later: The default container runtime varies depending on the OS. For nodes running EulerOS 2.5 or EulerOS 2.8, the default container runtime is docker; for nodes running other OSs, the default container runtime is containerd.

ecs:performancetype

String

ECS flavor types. This field is returned in the response.

orderID

String

Order ID. This parameter is returned in the response when the node is billed on a yearly/monthly basis with auto payment enabled (only in creation scenarios).

productID

String

Product ID. This field is returned in the response when the node is yearly/monthly-billed with auto payment enabled.

maxPods

Integer

Maximum number of pods that can be created on a node, including the default system pods. Value range: 16 to 256.

This limit prevents the node from being overloaded of pods.

The number of pods that can be created on a node is determined by multiple parameters. For details, see Maximum Number of Pods That Can Be Created on a Node.

periodType

String

• month: The unit is month.

• year: The unit is year.

periodNum

Integer

Subscription duration. The value can be:

• If periodType is month, the value ranges from 1 to 9.

• If periodType is year, the value is 1.

isAutoRenew

String

Whether auto renewal is enabled.

• true: Auto renewal is enabled.

• false: Auto renewal is not enabled.

isAutoPay

String

Whether to deduct fees automatically.

• true: Enable automatic fee deduction.

• false: Do not enable automatic fee deduction.

DockerLVMConfigOverride

String

Docker data disk configuration item. (This parameter has been discarded. Use the storage field instead.) Example default configuration:

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

By default, if no VD disk is available, an error occurs because the data disk fails to be found. Set diskType based on the actual drive letter type.

The following fields are included:

• userLV (optional): size of the user space, for example, vgpaas/20%VG.

• userPath (optional): mount path of the user space, for example, /home/wqt-test.

• diskType: disk type. Currently, only evs, hdd, and ssd are supported.

• lvType: type of a logic volume. The value can be linear or striped.

• dockerThinpool: Docker space size, for example, vgpaas/60%VG.

• kubernetesLV: kubelet space size, for example, vgpaas/20%VG.

dockerBaseSize

Integer

Available disk space of a single container on a node, in GB. This parameter has been discarded. Use containerBaseSize.

If this parameter is left blank or is set to 0, the default value is used. In Device Mapper mode, the default value is 10. In OverlayFS mode, the available space of a single container is not limited by default, and the dockerBaseSize setting takes effect only on nodes running EulerOS/Huawei Cloud EulerOS 2.0 in clusters of the new versions.

For details about how to allocate the space for the container runtime, see Data Disk Space Allocation.

When Device Mapper is used, it is recommended that dockerBaseSize be set to a value less than or equal to 80 GB. If the value is too large, the container runtime may fail to be started due to long initialization. If there are special requirements for the container disk space, you can mount an external or local storage device.

containerBaseSize

Integer

Available disk space of a single container on a node, in GB.

If this parameter is left blank or is set to 0, the default value is used. In OverlayFS mode, the available space of a single container is not limited by default. In Device Mapper mode, the default value is 10, and the containerBaseSize setting takes effect only on nodes running EulerOS/Huawei Cloud EulerOS 2.0 in clusters v1.23.14-r0, v1.25.9-r0, v1.27.6-r0, v1.28.4-r0 or later.

For details about how to allocate the space for the container runtime, see Data Disk Space Allocation.

When Device Mapper is used, it is recommended that containerBaseSize be set to a value less than or equal to 80 GB. If the value is too large, the container runtime may fail to be started due to long initialization. If there are special requirements for the container disk space, you can mount an external or local storage device. In new versions, the Device Mapper mode is used only by BMSs in the same resource pool and is being discarded.

publicKey

String

Public key of a node.

alpha.cce/preInstall

String

Pre-installation script.

alpha.cce/postInstall

String

Post-installation script.

alpha.cce/NodeImageID

String

This parameter is required when a custom image is used to create a BMS node.

nicMultiqueue

String

• Number of ENI queues. Example setting:

"[{\"queue\":4}]"

The following fields are included:

• queue: number of ENI queues.

• This field can be configured only for BMS nodes in a CCE Turbo cluster.

• Supported proportions are {"1":128, "2":92, "4":92, "8":32, "16":16, "28":9}. That is, if there is one queue, a maximum of 128 ENIs can be bound. If there are two queues, a maximum of 92 ENIs can be bound for two queues.

• A larger number of ENI queues indicates higher performance but fewer ENIs can be bound. The queue settings cannot be changed after the node pool is created.

nicThreshold

String

• ENI pre-binding thresholds. Example setting:

"0.3:0.6"

• Low threshold (L): determines the minimum number of pre-bound ENIs (Min). Formula: Min = Total number of ENIs of the node x L

• High threshold (H): determines the maximum number of pre-bound ENIs (Max). Formula: Max = Total number of ENIs of the node x H

• Number of ENIs bound to a BMS node (B) and number of ENIs being used by pods (U): U + Min < B < U + Max

• If the number of pre-bound ENIs on a BMS node is smaller than the minimum allowed, the system will bind more ENIs to make the numbers equal.

• If the number of pre-bound ENIs on a BMS node is larger than the maximum allowed, the system periodically unbinds ENIs (about every 2 minutes) to make the numbers equal.

• Both the thresholds are one-decimal-place values ranging from 0.0 to 1.0. The low threshold must be smaller than or equal to the high one.

• This field can be configured only for BMS nodes in a CCE Turbo cluster.

• Pre-binding ENIs can speed up workload creation but occupies IP addresses.

chargingMode

Integer

Billing mode of a node. This parameter has been deprecated. Use the billingMode parameter in NodeSpec.

marketType

String

Specifies the market type. When creating a spot ECS, set this parameter to spot.

spotPrice

String

Specifies the highest price per hour users accept for a spot ECS.

agency_name

String

Name of an agency

An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for CCE nodes to access cloud servers.

This parameter is returned only when it is transferred during node creation.

kubeReservedMem

Integer

Reserved node memory, which is reserved for Kubernetes components.

systemReservedMem

Integer

Reserved node memory, which is reserved for system components.

init-node-password

String

Node password. If this parameter is used as a response parameter, asterisks (*) will be displayed.

type

String

Configuration type of the Kubernetes node name. The default value is privateIp.

• privateIp: The Kubernetes node is named after its IP address.

• cceNodeName: The Kubernetes node is named after the CCE node.

phase

String

Node status, which is the status of a node during its lifecycle (such as installation and uninstallation) or the status of a node in a Kubernetes cluster. Options:

• Build: The node is being created.

• Installing: The node is being managed.

• Upgrading: The node is being upgraded.

• Active: The node is running properly.

• Abnormal: The node is abnormal.

• Deleting: The node is being deleted.

• Error: The node is faulty.

lastProbeTime

String

Last time when the node status was checked. If the cluster is in the abnormal, frozen, or intermediate state (for example, creating), the node status check may be affected. The node status that takes more than five minutes to check has no reference value.

jobID

String

ID of a creation or deletion job

serverId

String

ID of the underlying ECS or BMS node

privateIP

String

IP address in the private network segment of the primary NIC on the node

privateIPv6IP

String

IPv6 address in the private network segment of the primary NIC on the node

publicIP

String

Node EIP. If the ECS data is not synchronized in real time, you can click Sync Node Data on the console to manually update the data.

deleteStatus

DeleteStatus object

Resource status during resource deletion.

previous_total

Integer

Total number of existing cluster resource records when the cluster is deleted.

current_total

Integer

Latest number of resource records, which is generated based on the current cluster resource records.

updated

Integer

Total number of resource records updated when the cluster is deleted.

added

Integer

Total number of resource records updated when the cluster is deleted.

deleted

Integer

Total number of resource records deleted when the cluster is deleted.

200

Information about the specified node is successfully obtained.