Help Center/ Cloud Container Engine/ API Reference (ME-Abu Dhabi Region)/ APIs/ Node Pool Management/ Creating a Node Pool

Updated on 2023-06-27 GMT+08:00

View PDF

Creating a Node Pool

Function

This API is used to create a node pool in a specified cluster. This API can be called only when the cluster is in the available, scaling-out, or scaling-in state.

When creating a node pool in a cluster of v1.21, you can bind security groups to the node pool. A maximum of five security groups can be bound to a node pool.

After the security groups of a node pool are updated, the update takes effect only for newly created pods. You are advised to evict the original pods on the node.

If there is no cluster, create one. The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
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.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
kind	Yes	String	API type. The value is fixed at NodePool.
apiVersion	Yes	String	API version. The value is fixed at v3.
metadata	Yes	NodePoolMetadata object	Metadata information of the node pool
spec	Yes	NodePoolSpec object	Node pool specifications
status	No	NodePoolStatus object	Node pool status

**Table 4** NodePoolMetadata
Parameter	Mandatory	Type	Description
name	Yes	String	Node pool name. NOTE: Naming rules: Enter 1 to 50 characters, starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. You cannot create node pools named DefaultPool.
uid	No	String	UID of the node pool. The value is automatically generated after the object is updated. A user-defined value will not take effect.
annotations	No	Map<String,String>	Annotations of a node pool in key-value pairs
updateTimestamp	No	String	Update time.
creationTimestamp	No	String	Creation time.

**Table 5** NodePoolSpec
Parameter	Mandatory	Type	Description
type	No	String	Node pool type. If this parameter is left blank, the value vm is used by default. vm: ECS ElasticBMS: C6 general computing-plus BMS. An example specification is c6.22xlarge.2.physical.
nodeTemplate	Yes	NodeSpec object	Detailed parameters of the node pool template.
initialNodeCount	No	Integer	Initial number of nodes for the node pool. When queried, the value is the number of target nodes in the node pool.
autoscaling	No	NodePoolNodeAutoscaling object	Auto scaling parameters
nodeManagement	No	NodeManagement object	Node management configuration
podSecurityGroups	No	Array of SecurityID objects	Security groups configuration
customSecurityGroups	No	Array of strings	Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. Specifying no security group ID will add the new nodes to the default security group of the worker nodes. Specifying a valid security group ID will put new nodes in that security group. When specifying a security group, do not modify the rules of the port on which CCE running depends.

**Table 6** NodeSpec
Parameter	Mandatory	Type	Description
flavor	Yes	String	Node specifications. For details about the node specifications supported by CCE, see Node Flavor Description.
az	Yes	String	Name of the AZ where the node to be created is located. . .
os	No	String	Node OS. For details about the supported OSs, see Node OS Description. NOTE: The system automatically selects the supported OS based on the cluster version. If the current cluster version does not support the OS, an error will be reported. If alpha.cce/NodeImageID in extendParam is specified during node creation, you do not need to set this field.
login	Yes	Login object	Node login mode. Either the key pair or password must be used for login.
rootVolume	Yes	Volume object	Information about disks on the node
dataVolumes	Yes	Array of Volume objects	Data disk parameters of the node. Currently, you can add the second data disk for your node on the CCE console. This data disk is used by the container runtime and kubelet. Do not uninstall this disk. Otherwise, the node will become unavailable. For DeC nodes, the parameter description is the same as that for rootVolume.
storage	No	Storage object	Disk initialization management parameter. This parameter is complex to configure. For details, see Attaching Disks to a Node. If this parameter retains its default, disks are managed based on the DockerLVMConfigOverride (discarded) parameter in extendParam. This parameter is supported by clusters of version 1.15.11 and later. NOTE: If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions.
publicIP	No	NodePublicIP object	EIP of a node. NOTE: This parameter is not supported when you add a node to a node pool.
nodeNicSpec	No	NodeNicSpec object	NIC of the node
count	No	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	No	Integer	Node billing mode. 0: pay-per-use
taints	No	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	No	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	No	String	Cloud server group ID. If this field is specified, the node is created in the specified cloud server group.
dedicatedHostId	No	String	ID of the DeH to which the node is scheduled. NOTE: This parameter is not supported when you add a node during node pool creation.
userTags	No	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	No	Runtime object	Container runtime. Defaults to docker.
initializedConditions	No	Array of strings	Custom initialization flag. Before CCE nodes are initialized, they are tainted with node.cloudprovider.kubernetes.io/uninitialized to prevent pods from being scheduled to them. CCE supports custom initialization flags. After receiving the initializedConditions parameter, CCE converts the parameter value into a node label and provisions the label with the node, for example, cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial. After the node is labeled, its status.Conditions is polled to check whether the type of conditions has a flag name, such as CCEInitial and CustomedInitial. If all input flags exist and their status is True, the node initialization is complete and the initialization taint is removed. Use only letters and digits. Max. characters: 20. Max. flags: 2.
extendParam	No	NodeExtendParam object	Extended parameters for creating a node.

**Table 7** Login
Parameter	Mandatory	Type	Description
sshKey	No	String	Name of the key pair used for login.
userPassword	No	UserPassword object	Password used for node login.

**Table 8** UserPassword
Parameter	Mandatory	Type	Description
username	No	String	Login account. Defaults to root.
password	Yes	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.

**Table 9** Volume
Parameter	Mandatory	Type	Description
size	Yes	Integer	Disk size, in GB. System disk: 40 to 1024 -Value range for data disks: 100 to 32768
volumetype	Yes	String	Disk type. For details about possible values, see the description of the root_volume parameter in the API used to create an ECS in the ECS API reference. SAS: high I/O disk SSD: ultra-high I/O disk SATA: common I/O disk SATA disks have been removed from EVS. You can find them attached only on existing nodes.
extendParam	No	Map<String,Object>	Extended disk parameters, defined in extendparam in the API used to create an ECS. . .
cluster_id	No	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.
cluster_type	No	String	Storage class of the cloud server system disk. The value is always dss. This field is used only for DeC clusters.
hw:passthrough	No	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	No	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.

**Table 10** VolumeMetadata
Parameter	Mandatory	Type	Description
__system__encrypted	No	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	No	String	CMK ID, which indicates encryption in metadata. This field is used with __system__encrypted.

**Table 11** Storage
Parameter	Mandatory	Type	Description
storageSelectors	Yes	Array of StorageSelectors objects	Disk selection. Matched disks are managed according to matchLabels and storageType.
storageGroups	Yes	Array of StorageGroups objects	A storage group consists of multiple storage devices. It is used to divide storage space.

**Table 12** StorageSelectors
Parameter	Mandatory	Type	Description
name	Yes	String	Selector name, used as the index of selectorNames in storageGroup. Therefore, the name of each selector must be unique.
storageType	Yes	String	Specifies the storage type. Currently, only evs (EVS volumes) and local (local volumes) are supported. The local storage does not support disk selection. All local disks will form a VG. Therefore, only one storageSelector of the local type is allowed.
matchLabels	No	matchLabels object	Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported.

**Table 13** matchLabels
Parameter	Mandatory	Type	Description
size	No	String	Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100
volumeType	No	String	EVS disk type. Currently, SSD, GPSSD and SAS are supported.
metadataEncrypted	No	String	Disk encryption identifier. 0 indicates that the disk is not encrypted, and 1 indicates that the disk is encrypted.
metadataCmkid	No	String	Customer master key ID of an encrypted disk. The value is a 36-byte string.
count	No	String	Number of disks to be selected. If this parameter is left blank, all disks of this type are selected.

**Table 14** StorageGroups
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a virtual storage group, which must be unique.
cceManaged	No	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	Yes	Array of strings	This parameter corresponds to name in storageSelectors. A group can match multiple selectors, but a selector can match only one group.
virtualSpaces	Yes	Array of VirtualSpace objects	Detailed management of space configuration in a group.

**Table 15** VirtualSpace
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a virtualSpace. Kubernetes: Kubernetes space configuration. lvmConfig needs to be configured. runtime: runtime space configuration. runtimeConfig needs to be configured. user: user space configuration. lvmConfig needs to be configured.
size	Yes	String	Size of a virtualSpace. The value must be an integer in percentage. Example: 90%. NOTE: The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.
lvmConfig	No	LVMConfig object	LVM configurations, applicable to kubernetes and user spaces. Note that one virtual space supports only one config.
runtimeConfig	No	RuntimeConfig object	runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config.

**Table 16** LVMConfig
Parameter	Mandatory	Type	Description
lvType	Yes	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	No	String	Path to which the disk is attached. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed.

**Table 17** RuntimeConfig
Parameter	Mandatory	Type	Description
lvType	Yes	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.

**Table 18** NodePublicIP
Parameter	Mandatory	Type	Description
ids	No	Array of strings	IDs of existing EIPs. The quantity cannot be greater than the number of nodes to be created. NOTE: If ids has been set, you do not need to set count and eip.
count	No	Integer	Number of EIPs to be dynamically created. NOTE: count and eip must be set at the same time.
eip	No	NodeEIPSpec object	EIP configuration.

**Table 19** NodeEIPSpec
Parameter	Mandatory	Type	Description
iptype	No	String	EIP type, specified in publicip.type in the API for assigning an EIP. . .
bandwidth	No	NodeBandwidth object	Bandwidth parameters of the EIP

**Table 20** NodeBandwidth
Parameter	Mandatory	Type	Description
chargemode	No	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. NOTE: Billed by bandwidth: The billing will be based on the data transmission rate (in Mbps) of public networks. This billing mode is recommended if your bandwidth usage is higher than 10%. Billed by traffic: The billing is based on the total amount of data (in GB) transmitted over the public network. This mode is available only when you are creating a pay-per-use node. This billing mode is recommended if your bandwidth usage is lower than 10%.
size	No	Integer	Bandwidth size, specified in bandwidth.size in the API for assigning an EIP. . .
sharetype	No	String	Bandwidth sharing type. Value options: PER (exclusive bandwidth)

**Table 21** NodeNicSpec
Parameter	Mandatory	Type	Description
primaryNic	No	NicSpec object	Description of the primary NIC.
extNics	No	Array of NicSpec objects	Extension NIC NOTE: This parameter is not supported when you add a node to a node pool.

**Table 22** NicSpec
Parameter	Mandatory	Type	Description
subnetId	No	String	ID of the subnet to which the NIC belongs. If subnetId is not specified when creating the primary NIC, the cluster subnet is used. When creating a secondary NIC, you must specify subnetId.
fixedIps	No	Array of strings	The IP address of the primary NIC is specified by fixedIps. The number of IP addresses cannot be greater than the number of created nodes. fixedIps and ipBlock cannot be specified at the same time.
ipBlock	No	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.

**Table 23** Taint
Parameter	Mandatory	Type	Description
key	Yes	String	Key.
value	No	String	Value.
effect	Yes	String	Effect.

**Table 24** UserTag
Parameter	Mandatory	Type	Description
key	No	String	Key of the cloud server label. The value cannot start with CCE- or __type_baremetal.
value	No	String	Value of the cloud server label.

**Table 25** Runtime
Parameter	Mandatory	Type	Description
name	No	String	Container runtime. Defaults to docker.

**Table 26** NodeExtendParam
Parameter	Mandatory	Type	Description
ecs:performancetype	No	String	ECS flavor types. This field is returned in the response.
maxPods	No	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.
DockerLVMConfigOverride	No	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	No	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 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 EulerOS nodes in the cluster of the new version. For details about how to allocate the space for the container runtime, see Data Disk Space Allocation. When Device Mapper is used, you are advised to set dockerBaseSize 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.
publicKey	No	String	Public key of a node.
alpha.cce/preInstall	No	String	Pre-installation script. NOTE: The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" \| base64)
alpha.cce/postInstall	No	String	Post-installation script. NOTE: The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" \| base64)
alpha.cce/NodeImageID	No	String	This parameter is required when a custom image is used to create a BMS node.
enterprise_project_id	No	String	ID of the enterprise project to which the node belongs
chargingMode	No	Integer	Billing mode of a node. This parameter has been deprecated. Use the billingMode parameter in NodeSpec.
agency_name	No	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.

**Table 27** NodePoolNodeAutoscaling
Parameter	Mandatory	Type	Description
enable	No	Boolean	Whether to enable auto scaling.
minNodeCount	No	Integer	Minimum number of nodes allowed if auto scaling is enabled. The value cannot be greater than the maximum number of nodes allowed by the cluster specifications.
maxNodeCount	No	Integer	Maximum number of nodes allowed if auto scaling is enabled. This value must be greater than or equal to the value of minNodeCount and cannot exceed the maximum number of nodes in the cluster specifications.
scaleDownCooldownTime	No	Integer	Interval between two scaling operations, in minutes. During this period, nodes added after a scale-up will not be deleted.
priority	No	Integer	Weight of a node pool. A node pool with a higher weight has a higher priority during scaling.

**Table 28** NodeManagement
Parameter	Mandatory	Type	Description
serverGroupReference	No	String	Cloud server group ID. If this field is specified, all nodes in the node pool will be created in this group. The group ID can be specified only when you create the node pool and cannot be modified. When you specify a cloud server group, the number of nodes in the node pool cannot exceed the group quota.

**Table 29** SecurityID
Parameter	Mandatory	Type	Description
id	No	String	Security group ID

**Table 30** NodePoolStatus
Parameter	Mandatory	Type	Description
currentNode	No	Integer	Total number of nodes in the current node pool (excluding the nodes that are being deleted)
creatingNode	No	Integer	Number of nodes in the creation process in the node pool
deletingNode	No	Integer	Number of nodes being deleted in the current node pool.
phase	No	String	Node pool status. Null: available (the number of current nodes in the node pool has reached the expected value, and no node scaling is being performed.) Synchronizing: scaling in progress (the number of current nodes in the node pool does not reach the expected value and no node scaling is being performed.) Synchronized: pending scaling (the number of current nodes in the node pool does not reach the expected value, or node scaling is being performed.) SoldOut: The node pool cannot be scaled out. (This field is used in multiple scenarios, for example, resources in the node pool have been sold out or the resource quota is insufficient.) NOTE: This node pool status has been discarded and is reserved only for compatibility. You are not advised to use it. The replacements are as follows: Node pool scaling status: You can obtain accurate status of the current node pool based on parameters such as currentNode, creatingNode, or deletingNode. Node pool scale-out: You can use conditions to obtain the detailed status of a node pool. Scalable can replace SoldOut. Deleting: The object is being deleted. Error: An error occurs.
jobId	No	String	ID of a job executed on the node pool
conditions	No	Array of NodePoolCondition objects	Node pool status details. For details, see the definition of Condition.

**Table 31** NodePoolCondition
Parameter	Mandatory	Type	Description
type	No	String	Condition type. The options are as follows: Scalable: whether a node pool can be scaled. If the status is False, node pool scaling will not be triggered again. QuotaInsufficient: Quotas on which node pool scaling depends are insufficient, affecting the node pool scaling status. ResourceInsufficient: Resources on which node pool scaling depends are insufficient, affecting the node pool scaling status. UnexpectedError: The node pool fails to be scaled out due to unexpected reasons, affecting the node pool scaling status. Error: A node pool error occurs. A common trigger is deletion failure.
status	No	String	Current status of Condition. The options are as follows: "True" "False"
lastProbeTime	No	String	Time when the status was last checked
lastTransitTime	No	String	Time when the status was last changed
reason	No	String	Reason why the status was last changed
message	No	String	Detailed condition description

Response Parameters

Status code: 201

**Table 32** Response body parameters
Parameter	Type	Description
kind	String	API type. The value is fixed at NodePool.
apiVersion	String	API version. The value is fixed at v3.
metadata	NodePoolMetadata object	Metadata information of the node pool
spec	NodePoolSpec object	Node pool specifications
status	NodePoolStatus object	Node pool status

**Table 33** NodePoolMetadata
Parameter	Type	Description
name	String	Node pool name. NOTE: Naming rules: Enter 1 to 50 characters, starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. You cannot create node pools named DefaultPool.
uid	String	UID of the node pool. The value is automatically generated after the object is updated. A user-defined value will not take effect.
annotations	Map<String,String>	Annotations of a node pool in key-value pairs
updateTimestamp	String	Update time.
creationTimestamp	String	Creation time.

**Table 34** NodePoolSpec
Parameter	Type	Description
type	String	Node pool type. If this parameter is left blank, the value vm is used by default. vm: ECS ElasticBMS: C6 general computing-plus BMS. An example specification is c6.22xlarge.2.physical.
nodeTemplate	NodeSpec object	Detailed parameters of the node pool template.
initialNodeCount	Integer	Initial number of nodes for the node pool. When queried, the value is the number of target nodes in the node pool.
autoscaling	NodePoolNodeAutoscaling object	Auto scaling parameters
nodeManagement	NodeManagement object	Node management configuration
podSecurityGroups	Array of SecurityID objects	Security groups configuration
customSecurityGroups	Array of strings	Custom security group settings for a node pool. New nodes scaled out in a node pool can be bound to a specified security group. Specifying no security group ID will add the new nodes to the default security group of the worker nodes. Specifying a valid security group ID will put new nodes in that security group. When specifying a security group, do not modify the rules of the port on which CCE running depends.

**Table 35** NodeSpec
Parameter	Type	Description
flavor	String	Node specifications. For details about the node specifications supported by CCE, see Node Flavor Description.
az	String	Name of the AZ where the node to be created is located. . .
os	String	Node OS. For details about the supported OSs, see Node OS Description. NOTE: The system automatically selects the supported OS based on the cluster version. If the current cluster version does not support the OS, an error will be reported. If alpha.cce/NodeImageID in extendParam is specified during node creation, you do not need to set this field.
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 the node. Currently, you can add the second data disk for your node on the CCE console. This data disk is used by the container runtime and kubelet. Do not uninstall this disk. Otherwise, the node will become unavailable. For DeC nodes, the parameter description is the same as that 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. NOTE: If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions.
publicIP	NodePublicIP object	EIP of a node. NOTE: This parameter is not supported when you add a node to a node pool.
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
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	Cloud server group ID. If this field is specified, the node is created in the specified cloud server group.
dedicatedHostId	String	ID of the DeH to which the node is scheduled. NOTE: This parameter is not supported when you add a node during node pool creation.
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. Defaults to docker.
initializedConditions	Array of strings	Custom initialization flag. Before CCE nodes are initialized, they are tainted with node.cloudprovider.kubernetes.io/uninitialized to prevent pods from being scheduled to them. CCE supports custom initialization flags. After receiving the initializedConditions parameter, CCE converts the parameter value into a node label and provisions the label with the node, for example, cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial. After the node is labeled, its status.Conditions is polled to check whether the type of conditions has a flag name, such as CCEInitial and CustomedInitial. If all input flags exist and their status is True, the node initialization is complete and the initialization taint is removed. Use only letters and digits. Max. characters: 20. Max. flags: 2.
extendParam	NodeExtendParam object	Extended parameters for creating a node.

**Table 36** Login
Parameter	Type	Description
sshKey	String	Name of the key pair used for login.
userPassword	UserPassword object	Password used for node login.

**Table 37** UserPassword
Parameter	Type	Description
username	String	Login account. Defaults to 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.

**Table 38** Volume
Parameter	Type	Description
size	Integer	Disk size, in GB. System disk: 40 to 1024 -Value range for data disks: 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 in the ECS API reference. SAS: high I/O disk SSD: ultra-high I/O disk SATA: common I/O 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. . .
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.
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.

**Table 39** VolumeMetadata
Parameter	Type	Description
__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.

**Table 40** Storage
Parameter	Type	Description
storageSelectors	Array of StorageSelectors objects	Disk selection. Matched disks are managed according to matchLabels and storageType.
storageGroups	Array of StorageGroups objects	A storage group consists of multiple storage devices. It is used to divide storage space.

**Table 41** StorageSelectors
Parameter	Type	Description
name	String	Selector name, used as the index of selectorNames in storageGroup. Therefore, the name of each selector must be unique.
storageType	String	Specifies the storage type. Currently, only evs (EVS volumes) and local (local volumes) are supported. The local storage does not support disk selection. All local disks will form a VG. Therefore, only one storageSelector of the local type is allowed.
matchLabels	matchLabels object	Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported.

**Table 42** matchLabels
Parameter	Type	Description
size	String	Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100
volumeType	String	EVS disk type. Currently, SSD, GPSSD and SAS are supported.
metadataEncrypted	String	Disk encryption identifier. 0 indicates that the disk is not encrypted, and 1 indicates that the disk is encrypted.
metadataCmkid	String	Customer master key ID of an encrypted disk. The value is a 36-byte string.
count	String	Number of disks to be selected. If this parameter is left blank, all disks of this type are selected.

**Table 43** StorageGroups
Parameter	Type	Description
name	String	Name of a virtual storage group, which must be unique.
cceManaged	Boolean	Storage space for Kubernetes and runtime components. Only one group can be set to true. If this parameter is left blank, the default value false is used.
selectorNames	Array of strings	This parameter corresponds to name in storageSelectors. A group can match multiple selectors, but a selector can match only one group.
virtualSpaces	Array of VirtualSpace objects	Detailed management of space configuration in a group.

**Table 44** VirtualSpace
Parameter	Type	Description
name	String	Name of a virtualSpace. Kubernetes: Kubernetes space configuration. lvmConfig needs to be configured. runtime: runtime space configuration. runtimeConfig needs to be configured. user: user space configuration. lvmConfig needs to be configured.
size	String	Size of a virtualSpace. The value must be an integer in percentage. Example: 90%. NOTE: The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.
lvmConfig	LVMConfig object	LVM configurations, applicable to kubernetes and user spaces. Note that one virtual space supports only one config.
runtimeConfig	RuntimeConfig object	runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config.

**Table 45** LVMConfig
Parameter	Type	Description
lvType	String	LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.
path	String	Path to which the disk is attached. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed.

**Table 46** RuntimeConfig
Parameter	Type	Description
lvType	String	LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance.

**Table 47** NodePublicIP
Parameter	Type	Description
ids	Array of strings	IDs of existing EIPs. The quantity cannot be greater than the number of nodes to be created. NOTE: If ids has been set, you do not need to set count and eip.
count	Integer	Number of EIPs to be dynamically created. NOTE: count and eip must be set at the same time.
eip	NodeEIPSpec object	EIP configuration.

**Table 48** NodeEIPSpec
Parameter	Type	Description
iptype	String	EIP type, specified in publicip.type in the API for assigning an EIP. . .
bandwidth	NodeBandwidth object	Bandwidth parameters of the EIP

**Table 49** NodeBandwidth
Parameter	Type	Description
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. NOTE: Billed by bandwidth: The billing will be based on the data transmission rate (in Mbps) of public networks. This billing mode is recommended if your bandwidth usage is higher than 10%. Billed by traffic: The billing is based on the total amount of data (in GB) transmitted over the public network. This mode is available only when you are creating a pay-per-use node. This billing mode is recommended if your bandwidth usage is lower than 10%.
size	Integer	Bandwidth size, specified in bandwidth.size in the API for assigning an EIP. . .
sharetype	String	Bandwidth sharing type. Value options: PER (exclusive bandwidth)

**Table 50** NodeNicSpec
Parameter	Type	Description
primaryNic	NicSpec object	Description of the primary NIC.
extNics	Array of NicSpec objects	Extension NIC NOTE: This parameter is not supported when you add a node to a node pool.

**Table 51** NicSpec
Parameter	Type	Description
subnetId	String	ID of the subnet to which the NIC belongs. If subnetId is not specified when creating the primary NIC, the cluster subnet is used. When creating a secondary NIC, you must specify subnetId.
fixedIps	Array of strings	The IP address of the primary NIC is specified by fixedIps. The number of IP addresses cannot be greater than the number of created nodes. fixedIps and ipBlock cannot be specified at the same time.
ipBlock	String	CIDR format of the 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.

**Table 52** Taint
Parameter	Type	Description
key	String	Key.
value	String	Value.
effect	String	Effect.

**Table 53** UserTag
Parameter	Type	Description
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.

**Table 54** Runtime
Parameter	Type	Description
name	String	Container runtime. Defaults to docker.

**Table 55** NodeExtendParam
Parameter	Type	Description
ecs:performancetype	String	ECS flavor types. This field is returned in the response.
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.
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. 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 EulerOS nodes in the cluster of the new version. For details about how to allocate the space for the container runtime, see Data Disk Space Allocation. When Device Mapper is used, you are advised to set dockerBaseSize 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.
publicKey	String	Public key of a node.
alpha.cce/preInstall	String	Pre-installation script. NOTE: The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" \| base64)
alpha.cce/postInstall	String	Post-installation script. NOTE: The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" \| base64)
alpha.cce/NodeImageID	String	This parameter is required when a custom image is used to create a BMS node.
enterprise_project_id	String	ID of the enterprise project to which the node belongs
chargingMode	Integer	Billing mode of a node. This parameter has been deprecated. Use the billingMode parameter in NodeSpec.
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.

**Table 56** NodePoolNodeAutoscaling
Parameter	Type	Description
enable	Boolean	Whether to enable auto scaling.
minNodeCount	Integer	Minimum number of nodes allowed if auto scaling is enabled. The value cannot be greater than the maximum number of nodes allowed by the cluster specifications.
maxNodeCount	Integer	Maximum number of nodes allowed if auto scaling is enabled. This value must be greater than or equal to the value of minNodeCount and cannot exceed the maximum number of nodes in the cluster specifications.
scaleDownCooldownTime	Integer	Interval between two scaling operations, in minutes. During this period, nodes added after a scale-up will not be deleted.
priority	Integer	Weight of a node pool. A node pool with a higher weight has a higher priority during scaling.

**Table 57** NodeManagement
Parameter	Type	Description
serverGroupReference	String	Cloud server group ID. If this field is specified, all nodes in the node pool will be created in this group. The group ID can be specified only when you create the node pool and cannot be modified. When you specify a cloud server group, the number of nodes in the node pool cannot exceed the group quota.

**Table 58** SecurityID
Parameter	Type	Description
id	String	Security group ID

**Table 59** NodePoolStatus
Parameter	Type	Description
currentNode	Integer	Total number of nodes in the current node pool (excluding the nodes that are being deleted)
creatingNode	Integer	Number of nodes in the creation process in the node pool
deletingNode	Integer	Number of nodes being deleted in the current node pool.
phase	String	Node pool status. Null: available (the number of current nodes in the node pool has reached the expected value, and no node scaling is being performed.) Synchronizing: scaling in progress (the number of current nodes in the node pool does not reach the expected value and no node scaling is being performed.) Synchronized: pending scaling (the number of current nodes in the node pool does not reach the expected value, or node scaling is being performed.) SoldOut: The node pool cannot be scaled out. (This field is used in multiple scenarios, for example, resources in the node pool have been sold out or the resource quota is insufficient.) NOTE: This node pool status has been discarded and is reserved only for compatibility. You are not advised to use it. The replacements are as follows: Node pool scaling status: You can obtain accurate status of the current node pool based on parameters such as currentNode, creatingNode, or deletingNode. Node pool scale-out: You can use conditions to obtain the detailed status of a node pool. Scalable can replace SoldOut. Deleting: The object is being deleted. Error: An error occurs.
jobId	String	ID of a job executed on the node pool
conditions	Array of NodePoolCondition objects	Node pool status details. For details, see the definition of Condition.

**Table 60** NodePoolCondition
Parameter	Type	Description
type	String	Condition type. The options are as follows: Scalable: whether a node pool can be scaled. If the status is False, node pool scaling will not be triggered again. QuotaInsufficient: Quotas on which node pool scaling depends are insufficient, affecting the node pool scaling status. ResourceInsufficient: Resources on which node pool scaling depends are insufficient, affecting the node pool scaling status. UnexpectedError: The node pool fails to be scaled out due to unexpected reasons, affecting the node pool scaling status. Error: A node pool error occurs. A common trigger is deletion failure.
status	String	Current status of Condition. The options are as follows: "True" "False"
lastProbeTime	String	Time when the status was last checked
lastTransitTime	String	Time when the status was last changed
reason	String	Reason why the status was last changed
message	String	Detailed condition description

Example Requests

{
  "kind" : "NodePool",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "lc-it-nodepool-79796"
  },
  "spec" : {
    "initialNodeCount" : 0,
    "type" : "vm",
    "autoscaling" : {
      "enable" : false,
      "minNodeCount" : 0,
      "maxNodeCount" : 1,
      "scaleDownCooldownTime" : 0,
      "priority" : 0
    },
    "nodeManagement" : {
      "serverGroupReference" : ""
    },
    "nodeTemplate" : {
      "flavor" : "s6.large.2",
      "az" : "******",
      "os" : "EulerOS 2.5",
      "login" : {
        "sshKey" : "KeyPair-001"
      },
      "rootVolume" : {
        "volumetype" : "SAS",
        "size" : 40
      },
      "dataVolumes" : [ {
        "volumetype" : "SAS",
        "size" : 100,
        "extendParam" : {
          "useType" : "docker"
        }
      } ],
      "billingMode" : 0,
      "extendParam" : {
        "alpha.cce/preInstall" : "",
        "alpha.cce/postInstall" : "",
        "alpha.cce/NodeImageID" : "",
        "maxPods" : 110
      },
      "nodeNicSpec" : {
        "primaryNic" : {
          "subnetId" : "7e767d10-7548-4df5-ad72-aeac1d08bd8a"
        }
      }
    },
    "podSecurityGroups" : [ {
      "id" : ""
    } ]
  }
}

Example Responses

Status code: 201

The job for creating a node pool in a specified cluster is successfully delivered.

{
  "kind" : "NodePool",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "lc-it-nodepool-79796",
    "uid" : "99addaa2-69eb-11ea-a592-0255ac1001bb"
  },
  "spec" : {
    "type" : "vm",
    "nodeTemplate" : {
      "flavor" : "s6.large.2",
      "az" : "******",
      "os" : "EulerOS 2.5",
      "login" : {
        "sshKey" : "KeyPair-001"
      },
      "rootVolume" : {
        "volumetype" : "SAS",
        "size" : 40
      },
      "dataVolumes" : [ {
        "volumetype" : "SAS",
        "size" : 100,
        "extendParam" : {
          "useType" : "docker"
        }
      } ],
      "publicIP" : {
        "eip" : {
          "bandwidth" : { }
        }
      },
      "nodeNicSpec" : {
        "primaryNic" : {
          "subnetId" : "7e767d10-7548-4df5-ad72-aeac1d08bd8a"
        }
      },
      "billingMode" : 0,
      "extendParam" : {
        "alpha.cce/NodeImageID" : "",
        "alpha.cce/postInstall" : "",
        "alpha.cce/preInstall" : "",
        "maxPods" : 110
      },
      "k8sTags" : {
        "cce.cloud.com/cce-nodepool" : "lc-it-nodepool-79796"
      }
    },
    "autoscaling" : {
      "maxNodeCount" : 1
    },
    "nodeManagement" : { }
  },
  "status" : {
    "phase" : ""
  }
}