Obtaining Node Details (To Be Discarded)

project_id

Yes

String

Definition

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

Constraints

N/A

Range

The project ID of the account

Default Value

N/A

cluster_id

Yes

String

Definition

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

Constraints

N/A

Range

Cluster ID

Default Value

N/A

node_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

The request body type or format

Constraints

GET requests are not validated.

Range

• 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

Definition

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 about how to obtain a token, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

kind

String

Definition

API type

Constraints

The value cannot be changed.

Range

N/A

Default Value

Node

apiVersion

String

Definition

API version

Constraints

The value cannot be changed.

Range

N/A

Default Value

v3.1

metadata

NodeMetadata object

Definition

Node metadata, which is a collection of attributes

Constraints

N/A

spec

NodeForConsoleSpec object

Definition

Details about a node. CCE creates or updates objects by defining or updating spec.

Constraints

N/A

status

NodeForConsoleStatus object

Definition

Node status, which is dynamically recorded. Specifying node status during creation or modification is unnecessary and has no effect.

Constraints

N/A

name

String

Definition

Node name

Constraints

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

• If name is not specified or is set to an empty string, the node name is generated based on the default rule, which is cluster-name-random-characters. If the cluster name is too long, only the first 36 characters are used.

• If the number of nodes (count) is greater than 1, some random characters are added to the end of the entered node name according to the default rule, which is entered-name-random-characters. If the length of the entered node name exceeds 50 characters, CCE uses the first 50 characters and adds random characters to the end of the node name.

Range

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

Default Value

If name is not specified or is set to an empty string, the node name is generated based on the default rule, which is cluster-name-random-characters. If the cluster name is too long, only the first 36 characters are used.

uid

String

Definition

Node ID, which is unique and automatically generated after the resource is created. It cannot be specified.

Constraints

The value is automatically generated after the object is created. A user-defined value will not take effect.

Range

N/A

Default Value

N/A

annotations

Map<String,String>

Definition

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

Constraints

This parameter is only used for query and cannot be transferred through a request. Entered data of this parameter is invalid.

Range

Annotations are not used to identify or select objects. The metadata in annotations may be small or large, structured or unstructured, and may include characters that are not allowed in labels.

Default Value

N/A

Example:

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

creationTimestamp

String

Definition

Creation time

Constraints

The value is automatically generated after the object is created. A user-defined value will not take effect.

Range

N/A

Default Value

N/A

updateTimestamp

String

Definition

Update time

Constraints

The value is automatically generated after the object is updated. A user-defined value will not take effect.

Range

N/A

Default Value

N/A

ownerReferences

ownerReferences object

Definition

Owner object

Constraints

• The value is automatically generated after the object is created. A user-defined value will not take effect.

• This parameter is not present in the response of the API for creating a node.

Range

N/A

Default Value

N/A

nodepoolName

String

Definition

Node pool name

Constraints

The value is automatically generated after the object is created. A user-defined value will not take effect.

Range

N/A

Default Value

N/A

nodepoolID

String

Definition

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

Constraints

The value is automatically generated after the object is created. A user-defined value will not take effect.

Range

N/A

Default Value

N/A

hyperNodeName

String

Definition

Supernode name. If a node is not a supernode, this field is not displayed.

Constraints

N/A

Range

N/A

Default Value

N/A

hyperNodeID

String

Definition

Supernode ID. If a node is not a supernode, this field is not displayed.

Constraints

N/A

Range

N/A

Default Value

N/A

flavor

String

Definition

Node flavors. For details about the node flavors supported by CCE clusters, see Node Specifications.

Constraints

N/A

Range

N/A

Default Value

N/A

az

String

Definition

AZ where the node to be created is located. You need to specify the AZ name. Random AZs will not be allocated to the nodes created using APIs.

Constraints

When you are creating a node pool and configuring a scaling group, this parameter cannot be set to random.

Range

N/A

Default Value

N/A

os

String

Definition

OS type of a node. For details about the supported OSs, see Node OSs.

Constraints

• If this parameter is not specified when you create a node, CCE automatically selects an OS version supported by the cluster version.

• If a selected OS is not supported by the current cluster version, it will be automatically replaced with a supported OS of the same series.

• If the alpha.cce/NodeImageID parameter in extendParam is specified during node creation, the node will use private images. In this case, this parameter is optional.

• If the securityReinforcementType parameter in extendParam is set to cybersecurity during node creation, security hardening will be enabled for the node. In this case, the node OS must be Huawei Cloud EulerOS 2.0. If no private image is configured, this parameter must be set to Huawei Cloud EulerOS 2.0. If a private image is configured and the private image uses Huawei Cloud EulerOS 2.0, this parameter is optional.

Range

N/A

Default Value

N/A

login

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

rootVolume

Volume object

Definition

Disk information of a node

Constraints

N/A

dataVolumes

Array of Volume objects

Definition

Data disk parameters of a node. For Dec nodes, the parameter definition is the same as that in rootVolume.

Constraints

• 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 its maximum disk limit. (You can add more data disks to each of your nodes through the CCE console or APIs.)

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

• This parameter can be left empty only when a system disk is selected for the system components.

storage

Storage object

Definition

Disk initialization management parameter.

The setting of this parameter is complex. For details, see Attaching Disks to a Node.

Constraints

• This field is supported by clusters of 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, do 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.

publicIP

NodePublicIP object

Definition

EIP of a node

Constraints

This parameter is not supported when you add a node during node pool creation.

nodeNicSpec

NodeNicSpec object

Definition

Network interfaces of a node

Constraints

N/A

count

Integer

Definition

Number of nodes that can be created at a time

Constraints

• This parameter can be left empty when it is used for a node pool.

• This parameter is not returned during node pool creation or updates.

• This parameter is mandatory during node creation.

Range

Positive integers that are greater than or equal to 1 and less than or equal to the maximum limit

Default Value

N/A

billingMode

Integer

Definition

Billing mode of a node.

Constraints

N/A

Range

• 0: pay-per-use

• 1: yearly/monthly

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

Default Value

0

taints

Array of Taint objects

Definition

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 during node pool creation 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.

waitPostInstallFinish

Boolean

Definition

Whether pods can be scheduled onto a node before the post-installation script has completed execution during node creation. 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

k8sTags

Map<String,String>

Definition

Defined in key-value pairs.

• Key: The key must contain 1 to 63 characters that start and end 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.

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 during node pool creation and this field is returned during query. In other scenarios, this field is not returned during query.

Example:

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

Constraints

A maximum of 20 key-value pairs is allowed.

ecsGroupId

String

Definition

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

Constraints

This configuration does not take effect during node pool creation or updates. To ensure that all nodes in a node pool are in the same ECS group, configure nodeManagement in the node pool.

Range

N/A

Default Value

N/A

dedicatedHostId

String

Definition

ID of the DeH to which nodes will be scheduled

Constraints

This parameter is not supported when you add a node during node pool creation.

Range

N/A

Default Value

N/A

userTags

Array of UserTag objects

Definition

Cloud server resource tags. 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 during node pool creation and this field is returned during query. In other scenarios, this field is not returned during query.

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.

runtime

Runtime object

Definition

Container runtime

• In clusters earlier than v1.25, the default value is docker.

• In clusters of v1.25 or later, the default value varies with the OSs.

• Nodes running EulerOS 2.5 or EulerOS 2.8 only support docker. For nodes running other OSs, the default container runtime is containerd.

Constraints

N/A

initializedConditions

Array of strings

Definition

Custom initialization flag, which is left empty by default.

Before CCE nodes are initialized, they are tainted with node.cloudprovider.kubernetes.io/uninitialized to prevent pods from being scheduled to them. When creating a node, you can specify the initializedConditions parameter to control the taint removal time. By default, the timeout interval is not configured.

Example:

1. Create a node and 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.

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

NodeExtendParam object

Definition

Extended parameters for creating a node

Constraints

N/A

hostnameConfig

HostnameConfig object

Definition

Kubernetes node name configuration parameter

Constraints

The supported cluster version is v1.23.6-r0 to v1.25 or v1.25.2-r0 or later.

serverEnterpriseProjectID

String

Definition

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.

Constraints

When creating a node or node pool, you can specify an existing enterprise project for it. If this field is left empty, 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.

Range

N/A

Default Value

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

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

partition

String

Definition

Partition that a node belongs to. You can select central cloud or edge sites.

Constraints

This field can be specified only for CCE Turbo clusters with distributed clouds enabled.

Range

• center: center cloud

• AZ ID of the edge site

Default Value

N/A

nodeNameTemplate

nodeNameTemplate object

Definition

Fixed prefix and suffix of node names. Assume that different node pools in a cluster are used by different departments of a company. You can use the prefix and suffix to distinguish the departments and how they use the nodes. For example, you can set nodeNamePrefix to finance- to indicate the department name, set nodeNameSuffix to -product to indicate the production usage, and set the node pool name to gpu to indicate the service type. The nodes will have names in the format of finance-gpu(five-random-digits)-product.

Constraints

This function is only supported by clusters of v1.28.1, v1.27.3, v1.25.6, v1.23.11, v1.21.12, or later. This parameter is only valid for node pools.

Range

N/A

Default Value

N/A

cpu

Integer

Definition

Number of CPU cores on a node

Constraints

N/A

Range

N/A

Default Value

N/A

memory

Integer

Definition

Node memory size, unit (M)

Constraints

N/A

Range

N/A

Default Value

N/A

sshKey

String

Definition

Name of the key pair used for login

Constraints

N/A

Range

N/A

Default Value

N/A

userPassword

UserPassword object

Definition

Password used for node login

Constraints

N/A

removeUserPassword

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

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

String

Definition

Login account. The default value is root.

Constraints

N/A

Range

N/A

Default Value

root

password

String

Definition

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.

Range

A password must meet the following requirements:

• It must contain 8 to 26 characters.

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

• It cannot contain the username or the username spelled backwards.

Default Value

N/A

size

Integer

Definition

Disk size, in GiB

Constraints

N/A

Range

• System disk: 40 to 1024

• The first data disk: 20 to 32768 (When the default disk initialization configuration parameter storage is used, the valid range increases to 100 to 32768.)

• Other data disks: 10 to 32768. (When the default disk initialization configuration parameter storage is used, the valid range increases to 100 to 32768.)

Default Value

N/A

volumetype

String

Definition

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

Constraints

N/A

Range

• SATA: high I/O disks

• SSD: ultra-high I/O disks

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

• ESSD: extreme SSD disks

• GPSSD: general purpose SSD disks

• ESSD2: extreme SSD V2 disks

• GPSSD2: general purpose SSD V2 disks

Default Value

N/A

extendParam

Map<String,Object>

Definition

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

For details, see extendparam Field Description for Creating Disks.

Constraints

N/A

cluster_id

String

Definition

ID of the storage pool used by the ECS system disk. This field is used only for DeC clusters and functions as the ID of the DSS storage pool (dssPoolID).

For details about how to obtain the storage pool ID, see the id field in Table 3 Response parameters in Obtaining Details of a DSS Storage Pool.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_type

String

Definition

Storage type of an ECS system disk

Constraints

N/A

Range

This field is used only for DeC clusters, and the value is always dss.

Default Value

N/A

hw:passthrough

Boolean

Definition

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

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

• If the node specification involves both local and EVS disks, configure the disk initialization configuration management parameters. For details, see Attaching Disks to a Node.

Constraints

N/A

Range

N/A

Default Value

N/A

metadata

VolumeMetadata object

Definition

EVS disk encryption information. This parameter is mandatory only when the system disk or data disk of the node to be created needs encryption.

Constraints

N/A

__system__encrypted

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

If this parameter does not appear, the disk is not encrypted.

__system__cmkid

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

storageSelectors

Array of StorageSelectors objects

Definition

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

N/A

storageGroups

Array of StorageGroups objects

Definition

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

Constraints

N/A

name

String

Definition

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

Constraints

The name of each selector must be unique.

Range

N/A

Default Value

N/A

storageType

String

Definition

Storage type

Constraints

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

• The system storage type does not support disk selection. Use the system disk to store system components. So, only one storage selector of the system type is allowed, and the name must be cceUse.

Range

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

Default Value

N/A

matchLabels

matchLabels object

Definition

Matching field of an EVS disk

Constraints

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

Range

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

Default Value

N/A

size

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

volumeType

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

String

Definition

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 empty, there is no restriction on the disk encryption identifier.

Constraints

N/A

Range

N/A

Default Value

N/A

metadataCmkid

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

count

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Name of a virtual storage group, which must be unique

Constraints

N/A

Range

• 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

Boolean

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

selectorNames

Array of strings

Definition

Corresponds to name in storageSelectors. You can select multiple selectors for one group, but one group for one selector.

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

Array of VirtualSpace objects

Definition

Detailed management of space configurations in a group

Constraints

N/A

name

String

Definition

Name of a virtualSpace. Supported types include share, kubernetes, runtime, and user.

Constraints

N/A

Range

• 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

String

Definition

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

Constraints

N/A

Range

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

Default Value

N/A

lvmConfig

LVMConfig object

Definition

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

Constraints

One virtualSpace supports only one config.

runtimeConfig

RuntimeConfig object

Definition

Runtime configuration management, which is applicable to runtime space configuration

Constraints

One virtualSpace supports only one config.

lvType

String

Definition

LVM write mode. The value can be linear or striped. 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

N/A

Range

N/A

Default Value

N/A

path

String

Definition

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/, and /var/script/

Range

N/A

Default Value

N/A

lvType

String

Definition

LVM write mode. The value can be linear or striped. 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

N/A

Range

N/A

Default Value

N/A

ids

Array of strings

Definition

IDs of existing EIPs

Constraints

• The quantity cannot be greater than the number of nodes to be created.

• If ids has been specified, you do not need to configure count or eip.

count

Integer

Definition

Number of EIPs to be dynamically created

Constraints

count and eip must be configured simultaneously.

Range

N/A

Default Value

N/A

eip

NodeEIPSpec object

Definition

EIP configuration

Constraints

This parameter is not supported during node pool creation.

iptype

String

Definition

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

For details, see Assigning an EIP.

Constraints

N/A

Range

N/A

Default Value

N/A

bandwidth

NodeBandwidth object

Definition

Bandwidth parameters of an EIP

Constraints

N/A

chargemode

String

Definition

Bandwidth billing mode

Constraints

N/A

Range

• If it is not transferred, the billing is based on bandwidth.

• If it is left empty, the billing is based on bandwidth.

• If it is set to traffic, the billing is based on traffic.

• If it is set to another value, the ECS creation will fail.

Default Value

N/A

size

Integer

Definition

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

For details, see Assigning an EIP.

Constraints

N/A

Range

N/A

Default Value

N/A

sharetype

String

Definition

Bandwidth sharing type. Dedicated bandwidth is supported only, and it is specified by PER.

Constraints

N/A

Range

N/A

Default Value

N/A

primaryNic

NicSpec object

Definition

Description of the primary network interface

Constraints

N/A

extNics

Array of NicSpec objects

Definition

Extended network interface

Constraints

This parameter is not supported when you add a node during node pool creation.

subnetId

String

Definition

ID of the subnet to which a network interface belongs. If subnetList is also configured for a node pool, the subnetList field is used for adding subnets to the node pool.

Constraints

• If subnetId is not specified when a primary network interface is creating, the cluster subnet will be used.

• When creating an extended network interface, you must specify subnetId.

Range

N/A

Default Value

N/A

fixedIps

Array of strings

Definition

The IP address of a primary network interface is specified using fixedIps. The number of IP addresses cannot be greater than the number of created nodes.

Constraints

• Either fixedIps or ipBlock can be specified.

• fixedIps cannot be specified for extended network interfaces.

• This parameter cannot be configured during node pool creation.

• This parameter is not present in the responses related to node pools.

ipBlock

String

Definition

CIDR format of the IP address range of the primary network interface. The IP address of a created node falls in this range.

Constraints

• Either fixedIps or ipBlock can be specified.

• This parameter cannot be configured during node pool creation.

• This parameter is not present in the responses related to node pools.

Range

N/A

Default Value

N/A

subnetList

Array of strings

Definition

Network ID list of the subnet where the network interface resides. Multiple subnets can be configured for a node pool.

Constraints

A maximum of 20 subnets can be configured.

key

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

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

String

Definition

Effect of a Kubernetes taint

Constraints

N/A

Range

NoSchedule, PreferNoSchedule, or NoExecute

Default Value

N/A

key

String

Definition

Key of a cloud server tag

Constraints

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

Range

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

String

Definition

Value of a cloud server tag

Constraints

N/A

Range

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

name

String

Definition

Container runtime

Constraints

N/A

Range

N/A

Default Value

• In clusters earlier than v1.25, the default value is docker.

• In clusters of v1.25 or later, the default value varies with the OSs.

• Nodes running EulerOS 2.5 or EulerOS 2.8 only support docker. For nodes running other OSs, the default container runtime is containerd.

ecs:performancetype

String

Definition

Type of an ECS flavor. This field is returned in the response.

Constraints

N/A

Range

N/A

Default Value

N/A

orderID

String

Definition

Order ID

Constraints

This parameter is included in the responses only during node creation if the node is billed on a yearly/monthly basis with auto payment enabled. It is not returned in the responses related to node pools.

Range

N/A

Default Value

N/A

productID

String

Definition

Product ID

Constraints

This parameter is included in the responses if the node is billed on a yearly/monthly basis with auto payment enabled or the node pool is billed on a yearly/monthly basis.

Range

N/A

Default Value

N/A

maxPods

Integer

Definition

The maximum number of pods that can be created on a node, including the default system pods.

This limit prevents the node from being overloaded with 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.

Constraints

N/A

Range

16 to 256

Default Value

N/A

periodType

String

Definition

Subscription type

Constraints

• As a request parameter, it is valid and mandatory only when billingMode is set to 1 (yearly/monthly billing) or 2 (yearly/monthly billing with auto payment enabled). The latter option has been discarded.

• As a response parameter, it is returned only when a yearly/monthly node is created.

Range

• month: The subscription period is month.

• year: The subscription period is year.

Default Value

N/A

periodNum

Integer

Definition

Subscription term

Constraints

• As a request parameter, it is valid and mandatory only when billingMode is set to 1 (yearly/monthly billing) or 2 (yearly/monthly billing with auto payment enabled). The latter option has been discarded.

• As a response parameter, it is returned only when a yearly/monthly node is created.

Range

• 1 to 9 if periodType is set to month

• 1 to 3 if periodType is set to year

Default Value

N/A

isAutoRenew

String

Definition

Whether to enable auto renewal

Constraints

This field is valid when billingMode is set to 1 or 2 (discarded). If not specified, auto renewal is not enabled.

Range

• true: Auto renewal is enabled.

• false: Auto renewal is disabled.

Default Value

N/A

isAutoPay

String

Definition

Whether an order is automatically paid

Constraints

This field is valid when billingMode is set to 1 or 2 (discarded). If not specified when billingMode is set to 1, auto payment is not enabled. If not specified when billingMode is set to 2 (discarded), auto payment is enabled by default.

Range

• true: Auto payment is enabled.

• false: Auto payment is disabled.

Default Value

N/A

DockerLVMConfigOverride

String

Definition

Docker data disk configuration item. This parameter has been discarded. Use storage instead. The following is an example of the 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. Specify diskType based on the actual drive letter type.

Constraints

N/A

Range

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

Default Value

N/A

dockerBaseSize

Integer

Definition

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

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

Constraints

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

• dockerBaseSize takes effect only on nodes running EulerOS or Huawei Cloud EulerOS 2.0 in clusters of v1.19.16-r0, v1.21.3-r0, v1.23.3-r0, or later.

Range

10 to 500

Default Value

If the value is not specified or is set to 0, the default value is used.

• The default value is 10 in Device Mapper mode.

• In OverlayFS mode, no fixed upper limit is imposed on the available space of a single container.

containerBaseSize

Integer

Definition

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

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

Constraints

• 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 shared resource pools and is being discarded.

• The containerBaseSize setting takes effect only on nodes running EulerOS or Huawei Cloud EulerOS 2.0 in clusters of the new version (v1.23.14-r0, v1.25.9-r0, v1.27.6-r0, v1.28.4-r0, or later).

• This parameter cannot be updated during node pool updates.

Range

10 to 500

Default Value

If the value is not specified or is set to 0, the default value is used.

• The default value is 10 in Device Mapper mode.

• In OverlayFS mode, no fixed upper limit is imposed on the available space of a single container.

publicKey

String

Definition

Public key of a node, which is used for SSH key login

Constraints

• This parameter is invalid if you use a key pair to log in to the node.

• This parameter cannot be configured during node pool creation or updates.

Range

N/A

Default Value

N/A

alpha.cce/preInstall

String

Definition

Pre-installation script

The input value must be encoded using Base64. The method is as follows:

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

Constraints

The characters of both the pre-installation and post-installation scripts are centrally calculated, and the total number of characters after transcoding cannot exceed 10,240.

Range

N/A

Default Value

N/A

alpha.cce/postInstall

String

Definition

Post-installation script

The input value must be encoded using Base64. The method is as follows:

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

Constraints

The characters of both the pre-installation and post-installation scripts are centrally calculated, and the total number of characters after transcoding cannot exceed 10,240.

Range

N/A

Default Value

N/A

alpha.cce/NodeImageID

String

Definition

Private image ID of a node, which is obtained from the IMS console. This parameter is required when private images are used.

Constraints

N/A

Range

N/A

Default Value

N/A

chargingMode

Integer

Definition

Billing mode of a node. This parameter has been discarded. Use billingMode in NodeSpec instead.

Constraints

N/A

Range

N/A

Default Value

N/A

marketType

String

Definition

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

Constraints

This parameter is valid only when billingMode is set to 0.

Range

N/A

Default Value

N/A

spotPrice

String

Definition

The highest price per hour the user accepts for a spot ECS.

Constraints

• This parameter takes effect only when billingMode is set to 0 and marketType is set to spot.

• When billingMode is set to 0 and marketType is set to spot, if spotPrice is not specified, the pay-per-use price is used by default.

• The spotPrice value must be less than or equal to the pay-per-use price and be greater than or equal to the ECS market price.

Range

N/A

Default Value

N/A

agency_name

String

Definition

Agency name.

An agency is created by a tenant administrator on IAM to provide temporary credentials for CCE nodes to access cloud servers.

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

Constraints

N/A

Range

N/A

Default Value

N/A

kubeReservedMem

Integer

Definition

Reserved node memory, which is reserved for Kubernetes components. The value varies with node flavors. For details, see Node Resource Reservation Rules.

Constraints

N/A

Range

N/A

Default Value

N/A

systemReservedMem

Integer

Definition

Reserved node memory, which is reserved for system components. The value varies with node flavors. For details, see Node Resource Reservation Rules.

Constraints

N/A

Range

N/A

Default Value

N/A

init-node-password

String

Definition

Node password. If this parameter is used only in a response, asterisks (*) are displayed. It is not returned in the responses related to node pools.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Configuration type of a 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. The node name cannot be changed. If the ECS name is changed on the ECS console, the node name will retain unchanged after 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).

Range

• privateIp: The private node IP address is used as the Kubernetes node name.

• cceNodeName: The CCE node name is used as the Kubernetes node name.

Default Value

privateIp

nodeNamePrefix

String

Definition

Node name prefix. If this parameter is left empty or set to the default value, no prefix will be added to the node name.

Constraints

Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. The value must start with a lowercase letter and comply with the DNS subdomain naming rules defined in RFC 1123.

Range

N/A

Default Value

N/A

nodeNameSuffix

String

Definition

Node name suffix. If this parameter is left empty or set to the default value, no suffix will be added to the node name.

Constraints

Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. The value must end with a lowercase letter or digit and comply with the DNS subdomain naming rules defined in RFC 1123.

Range

N/A

Default Value

N/A

phase

String

Definition

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

Constraints

This parameter is not present in the response of the API for creating a node.

Range

Node resource lifecycle management (such as installation and uninstallation) status and Kubernetes node status in a cluster. The options include:

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

Default Value

N/A

lastProbeTime

String

Definition

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. If checking a node's status takes longer than 5 minutes, the result is considered meaningless.

Constraints

N/A

Range

N/A

Default Value

N/A

jobID

String

Definition

Job ID during creation or deletion

Constraints

N/A

Range

N/A

Default Value

N/A

serverId

String

Definition

ID of the underlying ECS or BMS node

Constraints

N/A

Range

N/A

Default Value

N/A

privateIP

String

Definition

Private IP address of the primary network interface on a node

Constraints

N/A

Range

N/A

Default Value

N/A

privateIPv6IP

String

Definition

Private IPv6 address of the primary network interface on a node

Constraints

N/A

Range

N/A

Default Value

N/A

publicIP

String

Definition

Node EIP. If the ECS data is not synchronized in real time, you can synchronize the node data through the console.

Constraints

N/A

Range

N/A

Default Value

N/A

deleteStatus

DeleteStatus object

Definition

Resource status during resource deletion

Constraints

N/A

Range

N/A

Default Value

N/A

configurationUpToDate

Boolean

Definition

Whether the node settings are consistent with the latest settings of the node template in the node pool to which the node belongs.

When a node pool's OS or runtime is updated, the existing nodes may have a different OS or runtime, causing configurationUpToDate to be false.

However, resetting the nodes will synchronize their OSs and runtimes with the node pool, setting configurationUpToDate to true.

Constraints

This parameter is not present in the response of the API for creating or updating a node.

Range

N/A

Default Value

N/A

imageID

String

Definition

Node OS image ID

Constraints

N/A

Range

N/A

Default Value

N/A

previous_total

Integer

Definition

The total number of existing cluster resource records during cluster deletion

Constraints

N/A

Range

N/A

Default Value

N/A

current_total

Integer

Definition

The latest number of resource records. This number is generated based on the current cluster resource records.

Constraints

N/A

Range

N/A

Default Value

N/A

updated

Integer

Definition

The total number of resource records updated during cluster deletion

Constraints

N/A

Range

N/A

Default Value

N/A

added

Integer

Definition

The total number of resource records added during cluster deletion

Constraints

N/A

Range

N/A

Default Value

N/A

deleted

Integer

Definition

The total number of resource records deleted during cluster deletion

Constraints

N/A

Range

N/A

Default Value

N/A

200