Listing All Node Pools in a Specified Cluster

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.

showDefaultNodePool

No

String

Whether to display the default node pool. By default, the default node pool is not displayed. If this parameter is set to true, the default node pool is displayed.

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

kind

String

API type. The value is fixed to List.

apiVersion

String

API version. The value is fixed to v3.

items

Array of NodePool objects

/

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

name

String

Node pool name.

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.

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.

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.

login

Login object

Node login mode.

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.

publicIP

NodePublicIP object

EIP of a node.

nodeNicSpec

NodeNicSpec object

NIC of the node

count

Integer

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

billingMode

Integer

Node billing mode.

• 0: pay-per-use

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.

userTags

Array of UserTag objects

Cloud server tag. The key of a tag must be unique. The maximum number of custom tags supported by CCE depends on the region and cannot exceed 8. When creating a node, you can specify the initial value for this parameter and this field is not returned during query. In using node pools, the initial value can be specified in the node template and this field is returned during query. In other scenarios, this field is not returned during query.

runtime

Runtime object

Container runtime:

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

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.

sshKey

String

Name of the key pair used for login.

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.

size

Integer

Disk size, in GB.

• System disk: 40 to 1024

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.

__system__encrypted

String

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

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

__system__cmkid

String

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

storageSelectors

Array of StorageSelectors objects

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

storageGroups

Array of StorageGroups objects

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

name

String

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

storageType

String

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.

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.

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.

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

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.

lvType

String

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

path

String

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

lvType

String

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

ids

Array of strings

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

count

Integer

Number of EIPs to be dynamically created.

eip

NodeEIPSpec object

EIP configuration.

iptype

String

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

bandwidth

NodeBandwidth object

Bandwidth parameters of the EIP

chargemode

String

Bandwidth billing mode.

• If this field is not specified, the billing is based on bandwidth. - If the field is null, the billing is based on bandwidth.
• If the field value is traffic, the billing is based on traffic.
• If the value is out of the preceding options, the cloud server will fail to be created.

size

Integer

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

sharetype

String

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

primaryNic

NicSpec object

Description of the primary NIC.

extNics

Array of NicSpec objects

Extension NIC

subnetId

String

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.

key

String

Key.

value

String

Value.

effect

String

Effect.

key

String

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

value

String

Value of the cloud server label.

name

String

Container runtime:

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

ecs:performancetype

String

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

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.

alpha.cce/postInstall

String

Post-installation script.

alpha.cce/NodeImageID

String

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

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.

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.

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.

id

String

Security group ID

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

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

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

200

Information about all node pools in the cluster is successfully obtained.