Updated on 2024-07-26 GMT+08:00

Reading a Specified Node Pool

Function

This API is used to obtain details about a specified node pool.

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.

Calling Method

For details, see Calling APIs.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}

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.

nodepool_id

Yes

String

Node pool ID.

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.

Response Parameters

Status code: 200

Table 3 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 of the node pool.

spec

NodePoolSpec object

Node pool specifications.

status

NodePoolStatus object

Node pool status.

Table 4 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. This parameter is used only for query and cannot be input through a request. Entered data of this parameter is invalid.

updateTimestamp

String

Update time.

creationTimestamp

String

Creation time.

Table 5 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 flavor is c6.22xlarge.2.physical.

  • bms: BMS

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 group configuration. This parameter is available only for CCE Turbo clusters.

extensionScaleGroups

ExtensionScaleGroup object

Configurations of extended scaling groups in a node pool

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.

Table 6 NodeSpec

Parameter

Type

Description

flavor

String

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

az

String

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

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

os

String

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

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 configure this parameter.

  • This parameter is mandatory when creating a node pool.

  • If you are using shared disk space when creating a node, this parameter is mandatory. Specifically, the disk initialization configuration management parameter storage is used and the name field of virtualSpaces in StorageGroups is set to share.

login

Login object

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

rootVolume

Volume object

Information about disks on the node

dataVolumes

Array of Volume objects

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

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

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

storage

Storage object

Disk initialization management parameter.

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

If this parameter retains its default, disks are managed based on the DockerLVMConfigOverride (discarded) parameter in extendParam. This parameter is supported by clusters of version 1.15.11 and later.

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

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

NOTE:
  • 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 Data Disk Space Allocation.

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

  • 1: yearly/monthly

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

taints

Array of Taint objects

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

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

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

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

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

Example:

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

k8sTags

Map<String,String>

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

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

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

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

Example:

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

ecsGroupId

String

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

NOTE:

This configuration does not take effect when a node pool is created. To ensure that all nodes in a node pool are in the same ECS group, configure nodeManagement in the node pool.

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.

NOTE:

Use only letters, Unicode characters, digits, special characters(-,_). Max characters: 36

runtime

Runtime object

Container runtime:

  • Clusters of v1.25 or earlier: docker.

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

initializedConditions

Array of strings

Custom initialization flag, which is left blank by default.

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

Example:

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

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

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

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

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

  • Max. flags: 2.

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

extendParam

NodeExtendParam object

Extended parameters for creating a node.

hostnameConfig

HostnameConfig object

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

serverEnterpriseProjectID

String

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

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

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

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

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

Table 7 Login

Parameter

Type

Description

sshKey

String

Name of the key pair used for login.

userPassword

UserPassword object

Password used for node login.

Table 8 UserPassword

Parameter

Type

Description

username

String

Login account. The default value is root.

password

String

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

A password must meet the following complexity requirements:

  • Contains 8 to 26 characters.

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

  • Cannot contain the username or the username spelled backwards.

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

Table 9 Volume

Parameter

Type

Description

size

Integer

Disk size, in GB.

  • Value range for system disks: 40 to 1024

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

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

volumetype

String

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

  • SAS: high I/O SAS disk

  • SSD: ultra-high I/O SSD disk

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

extendParam

Map<String,Object>

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

For details, see Creating an ECS.

cluster_id

String

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

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

cluster_type

String

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

hw:passthrough

Boolean

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

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

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

metadata

VolumeMetadata object

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

Table 10 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 11 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 12 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

Storage type. Only evs (EVS disks) and local (local disks) are supported. The local storage does not support disk selection. All local disks will form a VG, so only one storageSelector of the local type is allowed.

matchLabels

matchLabels object

Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported.

Table 13 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. SSD, GPSSD, SAS, ESSD, and SATA are supported. If this parameter is left blank, there is no restriction on the disk type.

metadataEncrypted

String

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

metadataCmkid

String

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

count

String

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

Table 14 StorageGroups

Parameter

Type

Description

name

String

Name of a virtual storage group, which must be unique.

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

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

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

cceManaged

Boolean

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

selectorNames

Array of strings

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

virtualSpaces

Array of VirtualSpace objects

Detailed management of space configuration in a group.

Table 15 VirtualSpace

Parameter

Type

Description

name

String

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

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

  • Kubernetes: Kubernetes space configuration. lvmConfig needs to be configured.

  • runtime: runtime space configuration. runtimeConfig needs to be configured.

  • user: user space configuration. lvmConfig needs to be configured.

size

String

Size of a virtualSpace. The value must be an integer in percentage. Example: 90%.

NOTE:

The sum of the percentages of all virtualSpaces in a group cannot exceed 100%.

lvmConfig

LVMConfig object

LVM configuration managements, applicable to the share*, kubernetes, and user spaces. Note that one virtual space supports only one config.

runtimeConfig

RuntimeConfig object

runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config.

Table 16 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 17 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 18 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 19 NodeEIPSpec

Parameter

Type

Description

iptype

String

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

For details, see Assigning an EIP.

bandwidth

NodeBandwidth object

Bandwidth parameters of the EIP

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

For details, see Assigning an EIP.

sharetype

String

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

Table 21 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 22 NicSpec

Parameter

Type

Description

subnetId

String

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

fixedIps

Array of strings

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

ipBlock

String

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

Table 23 Taint

Parameter

Type

Description

key

String

Key.

value

String

Value.

effect

String

Effect.

Table 24 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 25 Runtime

Parameter

Type

Description

name

String

Container runtime. Default value:

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

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

Table 26 NodeExtendParam

Parameter

Type

Description

ecs:performancetype

String

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

orderID

String

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

productID

String

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

maxPods

Integer

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

This limit prevents the node from being overloaded of pods.

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

periodType

String

  • month: The unit is month.

  • year: The unit is year.

NOTE:

Request parameter, which is valid and mandatory only when billingMode is set to 1 (yearly/monthly billing) or 2 (yearly/monthly billing with auto renewal enabled) (discarded).

Response parameter, which is returned only when a yearly/monthly node is created.

periodNum

Integer

Subscription duration. The value can be:

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

  • If periodType is year, the value is 1.

NOTE:

Request parameter, which is valid and mandatory when billingMode is set to 1 or 2 (discarded).

Response parameter, which is returned only when a yearly/monthly node is created.

isAutoRenew

String

Whether auto renewal is enabled.

  • true: Auto renewal is enabled.

  • false: Auto renewal is not enabled.

NOTE:

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

isAutoPay

String

Whether to deduct fees automatically.

  • true: Enable automatic fee deduction.

  • false: Do not enable automatic fee deduction.

NOTE:

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

DockerLVMConfigOverride

String

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

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

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

The following fields are included:

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

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

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

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

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

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

dockerBaseSize

Integer

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

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

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

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

containerBaseSize

Integer

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

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

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

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

publicKey

String

Public key of a node.

alpha.cce/preInstall

String

Pre-installation script.

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.

nicMultiqueue

String

  • Number of ENI queues. Example setting:

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

The following fields are included:

  • queue: number of ENI queues.

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

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

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

nicThreshold

String

  • ENI pre-binding thresholds. Example setting:

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

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

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

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

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

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

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

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

chargingMode

Integer

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

marketType

String

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

NOTE:

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

spotPrice

String

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

NOTE:

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 greater than or equal to the ECS market price.

agency_name

String

Name of an agency

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

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

kubeReservedMem

Integer

Reserved node memory, which is reserved for Kubernetes components.

systemReservedMem

Integer

Reserved node memory, which is reserved for system components.

init-node-password

String

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

Table 27 HostnameConfig

Parameter

Type

Description

type

String

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

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

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

NOTE:
  • For a node which is configured using cceNodeName, the name is the same as the Kubernetes node name and the ECS name. 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.

  • For a node which is configured using cceNodeName, to avoid a conflict between Kubernetes nodes, the system automatically adds a suffix to each node name. The suffix is in the format of A hyphen (-) Five random characters. The value of the random characters is a lowercase letter or a digit ranging from 0 to 9.

Table 28 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 29 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 30 SecurityID

Parameter

Type

Description

id

String

Security group ID

Table 31 ExtensionScaleGroup

Parameter

Type

Description

metadata

ExtensionScaleGroupMetadata object

Basic information about an extended scaling group

spec

ExtensionScaleGroupSpec object

Configurations of an extended scaling group, which carry different configurations from those of the default scaling group

Table 32 ExtensionScaleGroupMetadata

Parameter

Type

Description

uid

String

UUID of an extended scaling group, which is automatically generated by the system.

name

String

Name of an extended scaling group. The value cannot be default and can contain a maximum of 55 characters. Only digits, lowercase letters, and hyphens (-) are allowed.

Table 33 ExtensionScaleGroupSpec

Parameter

Type

Description

flavor

String

Node flavor

az

String

AZ of a node. If this parameter is not specified or left blank, the default scaling group configurations take effect.

capacityReservationSpecification

CapacityReservationSpecification object

Capacity reservation configurations of an extended scaling group

autoscaling

ScaleGroupAutoscaling object

Auto scaling configurations of an extended scaling group

Table 34 CapacityReservationSpecification

Parameter

Type

Description

id

String

Private pool ID. The parameter value can be ignored when preference is set to none.

preference

String

Capacity of a private storage pool. If the value is none, the capacity reservation is not specified. If the value is targeted, the capacity reservation is specified. In this case, the ID cannot be left blank.

Table 35 ScaleGroupAutoscaling

Parameter

Type

Description

enable

Boolean

Whether to enable auto scaling for a scaling group. This function is disabled by default.

extensionPriority

Integer

Priority of a scaling group. If no value is specified for this parameter, it defaults to 0. A higher value indicates a greater priority.

minNodeCount

Integer

Minimum number of nodes in a scaling group during auto scaling. The value must be greater than 0.

maxNodeCount

Integer

Maximum number of nodes that can be retained in a scaling group during auto scaling. The value must be greater than or equal to that of minNodeCount, and can neither be greater than the maximum number of nodes allowed by the cluster nor the maximum number of nodes in the node pool.

Table 36 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. This field is available only when the node pool is being deleted.

conditions

Array of NodePoolCondition objects

Node pool status details. For details, see the definition of Condition.

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

  • LockedByOrder: The yearly/monthly-billed node pool is locked due to an order. The value of Reason is the ID of the pending order.

  • 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

None

Example Responses

Status code: 200

Details about the specified node pool are obtained successfully.

{
  "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" : {
        "maxPods" : 110
      },
      "k8sTags" : {
        "cce.cloud.com/cce-nodepool" : "lc-it-nodepool-79796"
      }
    },
    "autoscaling" : { },
    "nodeManagement" : { }
  },
  "status" : {
    "phase" : "Deleting",
    "jobId" : "3281fa02-69ee-11ea-a592-0255ac1001bb"
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;


public class ShowNodePoolSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowNodePoolRequest request = new ShowNodePoolRequest();
        request.withClusterId("{cluster_id}");
        request.withNodepoolId("{nodepool_id}");
        try {
            ShowNodePoolResponse response = client.showNodePool(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowNodePoolRequest()
        request.cluster_id = "{cluster_id}"
        request.nodepool_id = "{nodepool_id}"
        response = client.show_node_pool(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowNodePoolRequest{}
	request.ClusterId = "{cluster_id}"
	request.NodepoolId = "{nodepool_id}"
	response, err := client.ShowNodePool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Details about the specified node pool are obtained successfully.

Error Codes

See Error Codes.