Accepting a Node

project_id

Yes

String

Details:

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

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

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

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

• application/json

• application/json;charset=utf-8

• application/x-pem-file

• multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

apiVersion

Yes

String

Definition

API version

Constraints

The value is fixed and cannot be changed.

Range

N/A

Default Value

v3

kind

Yes

String

Definition

API type

Constraints

The value is fixed and cannot be changed.

Range

N/A

Default Value

List

nodeList

Yes

Array of AddNode objects

Definition

List of the nodes to be managed

Constraints

A maximum of 200 nodes can be managed at a time.

serverID

Yes

String

Definition

Server ID, which can be obtained from the ECS or BMS console.

Constraints

N/A

Range

N/A

Default Value

N/A

spec

Yes

ReinstallNodeSpec object

Definition

Node reinstallation parameter settings

Constraints

N/A

os

Yes

String

Definition

OS. If you specify a private image, the actual OS version of the IMS image is used. Select an OS version supported by the current cluster, for example, Huawei Cloud EulerOS 2.0, Ubuntu 22.04, EulerOS 2.9, CentOS 7.6, and EulerOS 2.8.

Constraints

N/A

Range

N/A

Default Value

N/A

login

No

Login object

Definition

How to log in to a node. If this parameter is not specified, the password of the selected image will be kept. Ensure that you have set a password for the image.

Constraints

N/A

name

No

String

Definition

Node name. Specifying this field during reinstallation will change the node name, and the server name will change accordingly. By default, the current server name is used as the node name.

Constraints

The node name must contain 1 to 56 characters that start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.

Range

N/A

Default Value

N/A

serverConfig

No

ReinstallServerConfig object

Definition

Server settings

Constraints

N/A

volumeConfig

No

ReinstallVolumeConfig object

Definition

Volume management settings

Constraints

N/A

runtimeConfig

No

ReinstallRuntimeConfig object

Definition

Container runtime settings

Constraints

N/A

k8sOptions

No

ReinstallK8sOptionsConfig object

Definition

Kubernetes node settings

Constraints

N/A

lifecycle

No

NodeLifecycleConfig object

Definition

Customized node lifecycle settings

Constraints

N/A

initializedConditions

No

Array of strings

Definition

Custom initialization flag, which is left empty 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 managing or resetting a node, you can configure the initializedConditions parameter to control the taint removal time. By default, the timeout period is not configured.

Example:

1. To manage or reset a node, add "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 and add two flags whose type values are CCEInitial and CustomedInitial, respectively, and both status values are True.

3. CCE polls status.Conditions of nodes to check whether there are conditions whose type is CCEInitial or CustomedInitial. If such conditions exist and their statuses are True, the node initialization is complete and the initialization taint will be removed.

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

The following is an example of conditions settings:

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

Constraints

• The timeout interval in initializedConditions ranges from 1 to 99 in the unit of seconds.

• Each value must be between 1 and 20 characters long and can only contain letters and digits.

• The maximum number of flags cannot exceed 2.

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

extendParam

No

ReinstallExtendParam object

Definition

(Deprecated) Extended parameters for reinstallation

Constraints

N/A

hostnameConfig

No

HostnameConfig object

Definition

Parameter for configuring Kubernetes node name. The supported cluster version is v1.23.6-r0 to v1.25, or v1.25.2-r0 or later.

Constraints

This parameter is not supported during node resetting.

sshKey

No

String

Details:

Name of the key pair used for login

Constraints:

None

Options:

N/A

Default value:

N/A

userPassword

No

UserPassword object

Details:

Password used for node login

Constraints:

None

removeUserPassword

No

Boolean

Definition

Whether to remove the password login setting of a node pool during the node pool update

Constraints

This parameter is supported only during node pool updates. If it is set to true, no user password can be specified.

Range

N/A

Default Value

false

removeSSHKey

No

Boolean

Definition

Whether to remove the key pair login setting of a node pool during the node pool update

Constraints

This parameter is supported only during node pool updates. If it is set to true, no SSH key can be specified.

Range

N/A

Default Value

false

username

No

String

Details:

Login account. The default value is root.

Constraints:

None

Options:

N/A

Default value:

root

password

Yes

String

Details:

Login password. If a username and password are used when a node is created, this field is shielded in the response body.

Constraints:

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

Options:

A password must:

• Contain 8 to 26 characters.

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

• Not contain the username or the username spelled backwards.

Default value:

N/A

userTags

No

Array of UserTag objects

Definition

Cloud server resource tags

Constraints

The key of a tag must be unique. The maximum number of custom tags supported by CCE varies depending on regions and cannot exceed 8.

rootVolume

No

ReinstallVolumeSpec object

Definition

System disk reinstallation settings

Constraints

N/A

key

No

String

Details:

Key of the cloud server tag

Constraints:

The value cannot start with CCE-, __type_baremetal, or sys.

Options:

The value contains a maximum of 128 characters. The tag key must be unique and cannot start or end with a space. It cannot contain non-printable ASCII characters (0–31) or the following special characters: =*<>,|/

Default value:

N/A

value

No

String

Details:

Value of the cloud server tag

Constraints:

None

Options:

The value contains a maximum of 255 characters. The tag value cannot start or end with a space. It cannot contain non-printable ASCII characters (0–31) or the following special characters: =*<>,|

Default value:

N/A

imageID

No

String

Definition

Private image ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cmkID

No

String

Definition

CMK ID. If this parameter is left empty, the disk is not encrypted.

Constraints

N/A

Range

N/A

Default Value

N/A

lvmConfig

No

String

Definition

(Deprecated) Configuration item of a Docker data disk.

Example of the default configuration:

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

The following fields are included:

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

Constraints

N/A

Range

N/A

Default Value

N/A

storage

No

Storage object

Details:

Disk initialization management parameter.

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

Constraints:

• This field is supported by clusters v1.15.11-r0 and later versions. If the cluster version is not supported, this field will be ignored.

• If a node has both local and EVS disks attached, make sure to not keep the default value for this parameter, or it may result in unexpected disk partitions.

• If you want to change the value range of a data disk to 20 to 32768, do not use the default value.

• If you want to use the shared disk space (with the runtime and Kubernetes partitions cancelled), do not retain the default value of this parameter. For details about the shared disk space, see Space Allocation of a Data Disk.

• If you want to store system components in the system disk, do not use the default value.

storageSelectors

Yes

Array of StorageSelectors objects

Details:

Disk selection. Matched disks are managed based on matchLabels and storageType settings. Disks are matched in sequence. The matching rule in the front is matched first.

Constraints:

None

storageGroups

Yes

Array of StorageGroups objects

Details:

A storage group consisting of multiple storage devices, which are used to divide storage space.

Constraints:

None

name

Yes

String

Details:

Name of a selector, which is used as the index of selectorNames in storageGroup.

Constraints:

The name of each selector must be unique.

Options:

N/A

Default value:

N/A

storageType

Yes

String

Details:

Storage type

Constraints:

• The local storage type does not support disk selection. All local disks form a VG. Therefore, only one local storage selector is allowed.

• The system storage type does not support disk selection. It is recommended that you use the system disk to store system components. As a result, only one storage selector of the system type is allowed, and the name must be cceUse.

Options:

Only evs (EVS disks), local (local disks), and system (system disks) are supported.

Default value:

N/A

matchLabels

No

matchLabels object

Details:

Matching field of an EVS disk

Constraints:

If storageType is set to system (system disk), you do not need to configure this parameter.

Options:

The size, volumeType, metadataEncrypted, metadataCmkid, and count fields in DataVolume are supported.

Default value:

N/A

size

No

String

Details:

Matched disk size, for example, 100. If this parameter is left blank, the disk size is not limited.

Constraints:

None

Options:

N/A

Default value:

N/A

volumeType

No

String

Definition

EVS disk type. Supported types include SSD, GPSSD, SAS, ESSD, and SATA. If this parameter is left empty, there is no restriction on the EVS disk type.

Constraints

N/A

Range

N/A

Default Value

N/A

metadataEncrypted

No

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

metadataCmkid

No

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

count

No

String

Details:

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

Constraints:

None

Options:

N/A

Default value:

N/A

name

Yes

String

Details:

Name of a virtual storage group, which must be unique

Constraints:

None

Options:

• If cceManaged is set to true, the name field must be set to vgpaas.

• If the data disk is used as a temporary storage volume, the name field must be set to vg-everest-localvolume-ephemeral.

• If the data disk is used as a persistent storage volume, the name field must be set to vg-everest-localvolume-persistent.

Default value:

N/A

cceManaged

No

Boolean

Details:

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

Constraints:

None

Options:

N/A

Default value:

N/A

selectorNames

Yes

Array of strings

Details:

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

Constraints:

System components cannot be separately stored in the system disk and data disks. Therefore, when the selector type is set to system, only one selector can be selected for a group.

virtualSpaces

Yes

Array of VirtualSpace objects

Details:

Detailed management of space configurations in a group

Constraints:

None

name

Yes

String

Details:

Name of a virtualSpace. Only types of share, kubernetes, runtime, and user are supported.

Constraints:

None

Options:

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

Default value:

N/A

size

Yes

String

Details:

Size of a virtualSpace. The value must be an integer in percentage, for example, 90%.

Constraints:

None

Options:

10 to 90. The sum of percentages of all virtualSpaces in a group cannot exceed 100%.

Default value:

N/A

lvmConfig

No

LVMConfig object

Details:

LVM configuration management, which is applicable to share, Kubernetes, and user space configuration

Constraints:

One virtualSpace supports only one config.

runtimeConfig

No

RuntimeConfig object

Details:

Runtime configuration management, which is applicable to runtime space configuration

Constraints:

One virtualSpace supports only one config.

lvType

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

path

No

String

Details:

Disk mount path. This parameter only takes effect in user configuration. The value can be an absolute path containing digits, uppercase letters, lowercase letters, periods (.), hyphens (-), and underscores (_).

Constraints:

Do not leave the path empty or set it to a key OS path such as the root directory. Key OS paths that cannot be entered:

/, /home, /home/, /bin, /bin/, /lib, /lib/, /root, /root/, /boot, /boot/, /dev, /dev/, /etc, /etc/, /lost+found, /lost+found/, /mnt, /mnt/, /proc, /proc/,/sbin, /sbin/, /srv, /srv/, /tmp, /tmp/, /var, /var/, /media, /media/, /opt, /opt/, /selinux, /selinux/, /sys, /sys/, /usr, /usr/, /opt/cloud/, /mnt/paas/, /home/paas/, /var/paas/, /var/lib/, /var/script/

Options:

N/A

Default value:

N/A

lvType

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

dockerBaseSize

No

Integer

Definition

Available disk space of a single container on a node (unit: G). This parameter has been deprecated. Use containerBaseSize.

If this parameter is left empty or is set to 0, the default value is used. In Device Mapper mode, the default value is 10. In OverlayFS mode, no fixed upper limit is imposed on the available space of a single container, 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 GiB. 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 external or local storage.

Constraints

N/A

Range

N/A

Default Value

N/A

containerBaseSize

No

Integer

Definition

Available disk space of a single container on a node (unit: G).

If this parameter is left empty or is set to 0, the default value is used. In OverlayFS mode, no fixed upper limit is imposed on the available space of a single container. 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 of 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 GiB. 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 external or local storage. In new versions, the Device Mapper mode is used only by BMSs in the same resource pool and is being deprecated.

Constraints

Range

N/A

Default Value

N/A

runtime

No

Runtime object

Details:

Container runtime

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

• Clusters v1.25 or later: The default value varies with the OSs.

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

Constraints:

None

name

No

String

Details:

Container runtime

Constraints:

None

Options:

N/A

Default value:

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

• Clusters of v1.25 or later: The default value varies with the OSs.

• For nodes running EulerOS 2.5 or EulerOS 2.8, the default value is docker. For nodes running other OSs, the default value is containerd.

labels

No

Map<String,String>

Definition

Defined in key-value pairs.

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

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

Example:

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

Constraints

A maximum of 20 key-value pairs is allowed.

taints

No

Array of Taint objects

Details:

Taints, which can be added to nodes for anti-affinity configuration. Each taint contains the following parameters:

• Key: Enter 1 to 63 characters starting and ending with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key.

• Value: Enter 1 to 63 characters starting and ending with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

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

When creating a node, you can specify an initial value for this field and this field is not returned during query. In 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"
}]

Constraints:

A maximum of 20 taints can be configured.

maxPods

No

Integer

Definition

Maximum number of pods that can be created on a node, including the default pods. This parameter is used to prevent the node from being overloaded due to excessive pods. Set this parameter based on your service requirements.

Constraints

N/A

Range

16 to 256

Default Value

N/A

key

Yes

String

Definition

Key of a Kubernetes taint

Constraints

The value must contain 1 to 63 characters starting and ending with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Range

N/A

Default Value

N/A

value

No

String

Definition

Value of a Kubernetes taint

Constraints

The value must contain 1 to 63 characters starting and ending with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Range

N/A

Default Value

N/A

effect

Yes

String

Definition

Effect of a Kubernetes taint

Constraints

N/A

Range

NoSchedule, PreferNoSchedule, and NoExecute

Default Value

N/A

preInstall

No

String

Definition

Pre-installation script. The characters of both the pre-installation and post-installation scripts are centrally calculated. The input value must be encoded using Base64. The method is as follows:

echo -n "*<content-to-be-encoded>*" | base64

Constraints

The length cannot exceed 10,240 bytes.

Range

N/A

Default Value

N/A

postInstall

No

String

Definition

Pre-installation script. The characters of both the pre-installation and post-installation scripts are centrally calculated. The input value must be encoded using Base64. The method is as follows:

echo -n "*<content-to-be-encoded>*" | base64

Constraints

The length cannot exceed 10,240 bytes.

Range

N/A

Default Value

N/A

waitPostInstallFinish

No

Boolean

Definition

Whether pods can be scheduled onto a node before the post-installation script has completed execution during operations such as node reset, management, and batch reset. If the node belongs to a node pool, the node pool settings apply. If this parameter is not specified or is set to false, pods can be scheduled to an available node after the Kubernetes node is ready. If this parameter is set to true, pods can be scheduled to an available node only after the Kubernetes node is ready and the post-installation script has been executed.

Constraints

N/A

Range

• false: Pods can be scheduled to an available node after the Kubernetes node is ready.

• true: Pods can be scheduled to an available node only after the Kubernetes node is ready and the post-installation script has been executed.

Default Value

false

alpha.cce/NodeImageID

No

String

Definition

(Deprecated) ID of the user image to run the target OS.

Specifying this parameter is equivalent to specifying imageID in ReinstallVolumeSpec. The original value will be overwritten.

Constraints

N/A

Range

N/A

Default Value

N/A

type

Yes

String

Details:

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

Constraints:

• The node names, Kubernetes node names, and VM names of the nodes configured with cceNodeName are the same. Node names cannot be changed. Once a VM name is altered on the ECS console, the node name cannot be modified accordingly during ECS synchronization.

• To prevent conflicts between Kubernetes node names, a suffix is automatically added to the node name of a node configured with cceNodeName. The suffix consists of a hyphen (-) followed by five random lowercase letters and digits (0 to 9).

Options:

• privateIp: Use the private node IP address the as the Kubernetes node name.

• cceNodeName: Use the CCE node name as the Kubernetes node name.

Default value:

privateIp

jobid

String

Definition

ID returned after a job is submitted. This ID can be used to query the execution of the job.

Range

N/A

200

The job for accepting a node into a specified cluster is successfully delivered.