Deleting a Node Pool
Function
This API is used to delete a specified node pool.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
cce:nodepool:delete
Write
cluster *
g:EnterpriseProjectId
-
-
URI
DELETE /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
| cluster_id | Yes | String | Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
| nodepool_id | Yes | String | Details: Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A Default Value: N/A |
| X-Auth-Token | Yes | String | Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| kind | String | Details: API type Options: N/A Default value: NodePool |
| apiVersion | String | Details: API version Options: N/A Default value: v3 |
| metadata | NodePoolMetadata object | Details: Metadata of a node pool Options: N/A Default value: N/A |
| spec | NodePoolSpec object | Definition Node pool specifications |
| status | DeleteNodePoolStatus object | Details: Node pool status Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Node pool name DefaultPool. Range Enter 1 to 63 characters starting with a lowercase letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. |
| uid | String | Details: UID of a node pool Options: N/A Default value: N/A |
| annotations | Map<String,String> | Details: Annotations of a node pool in key-value pairs |
| updateTimestamp | String | Details: Time when a node pool was updated Options: N/A Default value: N/A |
| creationTimestamp | String | Details: Time when a node pool was created Options: N/A Default value: N/A |
| resourceVersion | Integer | Definition Timestamp of the last update time of a node pool Range N/A |
| Parameter | Type | Description |
|---|---|---|
| type | String | Details: Node pool type Options: Default value: vm |
| nodeTemplate | NodeTemplate object | Details: Detailed parameters of a node pool template |
| initialNodeCount | Integer | Details: The initial number of nodes in a node pool. The obtained value is the desired number of nodes in the node pool. Options: Values that are greater than or equal to 0 and less than or equal to the cluster scale Default value: 0 |
| autoscaling | NodePoolNodeAutoscaling object | Details: Auto scaling parameters |
| nodeManagement | NodeManagement object | Details: Node management configuration |
| podSecurityGroups | Array of SecurityID objects | Details: Security group configuration |
| extensionScaleGroups | Array of ExtensionScaleGroup objects | Definition Configuration list of the extended scaling groups in a node pool. For details, see the definition of ExtensionScaleGroup. |
| customSecurityGroups | Array of strings | Details: Custom security group configuration for a node pool. New nodes added to a node pool can be bound to a specified security group.
|
| taintPolicyOnExistingNodes | String | Definition: Taint synchronization policy of existing nodes. Options:
Default value: refresh |
| labelPolicyOnExistingNodes | String | Definition: Label synchronization policy of existing nodes. Options:
Default value: refresh |
| userTagsPolicyOnExistingNodes | String | Definition: Resource tag synchronization policy of existing nodes. Options:
Default value: ignore |
| Parameter | Type | Description |
|---|---|---|
| flavor | String | Definition Node flavors. For details about the node flavors supported by CCE clusters, see Node Specifications. Range N/A |
| az | String | Definition AZ where the node to be created is located. You need to specify the AZ name. Random AZs will not be allocated to the nodes created using APIs. For details about AZs supported by CCE, see Regions and Endpoints. random. Range N/A |
| os | String | Definition OS type of a node. For details about the supported OSs, see Node OSs. alpha.cce/NodeImageID parameter in extendParam is specified during node creation, the node will use private images. In this case, this parameter is optional. Range N/A |
| login | Login object | Definition How to log in to a node. If this parameter is not specified, the password of the selected image will be kept. Ensure that you have set a password for the image. |
| rootVolume | Volume object | Definition Disk information of a node |
| dataVolumes | Array of Volume objects | Definition Data disk parameters of a node. For DeC nodes, the parameter definitions are the same as those in rootVolume. |
| storage | Storage object | Definition: Disk initialization management parameter. This parameter is complex to configure. For details, see Attaching Disks to a Node. Range: N/A |
| publicIP | NodeEIPSpec object | Definition EIP parameters of a node Range N/A |
| nodeNicSpec | NodeNicSpec object | Definition Network interfaces of a node |
| count | Integer | Definition Number of nodes that can be created at a time Range Positive integers that are greater than or equal to 1 and less than or equal to the maximum limit |
| billingMode | Integer | Definition Billing mode of a node Range |
| taints | Array of Taint objects | Definition Taints, which can be added to nodes for anti-affinity configuration. Each taint contains the following parameters:
When creating a node, you can specify an initial value for this field, and this field is not returned during query. When creating a node pool, you can specify an initial value 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"
}] |
| waitPostInstallFinish | Boolean | Definition Whether pods can be scheduled onto a node before the post-installation script has completed execution during node creation. If this parameter is not specified or is set to false, pods can be scheduled to an available node after the Kubernetes node is ready. If this parameter is set to true, pods can be scheduled to an available node only after the Kubernetes node is ready and the post-installation script has been executed. Range |
| k8sTags | Map<String,String> | Definition This parameter is defined in key-value pairs.
When creating a node, you can specify an initial value for this field, and this field is not returned during query. When creating a node pool, you can specify an initial value 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 | Definition ECS group ID. If this parameter is specified, nodes will be created in the specific ECS group. nodeManagement in the node pool. Range N/A |
| dedicatedHostId | String | Definition ID of the DeH to which nodes will be scheduled Range N/A |
| userTags | Array of UserTag objects | Definition Cloud server tag (resource tag). When creating a node, you can specify an initial value for this field, and this field is not returned during query. When creating a node pool, you can specify an initial value in the node template, and this field is returned during query. In other scenarios, this field is not returned during query. |
| runtime | Runtime object | Definition Container runtime. |
| initializedConditions | Array of strings | Definition Custom initialization flag, which is left empty by default. Before CCE nodes are initialized, node.cloudprovider.kubernetes.io/uninitialized is added to the nodes to prevent pods from being scheduled to these nodes. When creating a node, you can configure the initializedConditions parameter to control the taint removal time. By default, the timeout period is not configured. Example:
status:
conditions:
- type: CCEInitial
status: 'True'
- type: CustomedInitial
status: 'True' initializedConditions ranges from 1 to 99 in the unit of seconds. |
| extendParam | NodeExtendParam object | Definition Extended parameters for creating a node |
| hostnameConfig | HostnameConfig object | Definition Kubernetes node name configuration parameter |
| serverEnterpriseProjectID | String | Definition Enterprise project ID of a server. CCE does not support features provided by EPS. This field is used only for synchronizing enterprise project IDs of servers. Range N/A |
| partition | String | Definition Zone that a node belongs to. It can be the central cloud or an edge site. Range |
| configurationsOverride | Array of PackageConfiguration objects | Definition: The default component configurations on a node will be overridden. (tag:hws) For details about the supported components and their parameters, see Configuring a Node Pool. |
| nodeNameTemplate | nodeNameTemplate object | Definition Fixed prefix and suffix of node names. Assume that different node pools in a cluster are used by different departments of a company. You can use the prefix and suffix to distinguish the departments and how they use the nodes. For example, you can set nodeNamePrefix to finance- to indicate the department name, set nodeNameSuffix to -product to indicate the production usage, and set the node pool name to gpu to indicate the service type. The nodes will have names in the format of finance-gpu(five-random-digits)-product. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| sshKey | String | Details: Name of the key pair used for login Options: N/A Default value: N/A |
| userPassword | UserPassword object | Definition: Password used for node login Range: N/A |
| removeUserPassword | Boolean | Definition Whether to remove the password login setting of a node pool during the node pool update true, no user password can be specified. Range N/A |
| removeSSHKey | Boolean | Definition Whether to remove the key pair login setting of a node pool during the node pool update true, no SSH key can be specified. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| username | String | Details: Login account. The default value is root. Options: N/A Default value: root |
| password | String | Details: Login password. If a username and password are used when a node is created, this field is shielded in the response body. password field must be salted during node creation. For details, see Adding a Salt in the password Field When Creating a Node. Options: A password must:
Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| size | Integer | Definition Disk size, in GiB Range
NOTE: For clusters of v1.28 and later, the value range of the system disk size can be 20 to 1024. |
| volumetype | String | Details: Disk type. For details about possible values, see the root_volume parameter in the API used to create an ECS. Options:
NOTE: For details about disk types, see Disk Types and Performance. Default value: N/A |
| extendParam | Map<String,Object> | Definition: Extended disk parameters, defined in extendparam in the API used to create an ECS. For details, see extendparam Field Description for Creating Disks. Range: N/A |
| cluster_id | String | Details: ID of the storage pool used by the ECS system disk. This field is used only for DeC clusters and 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. Options: N/A Default value: N/A |
| cluster_type | String | Details: Storage class of the ECS system disk Options: This field is used only for DeC clusters, and the value is always dss. Default value: N/A |
| hw:passthrough | Boolean | Details:
Options: N/A Default value: N/A |
| metadata | VolumeMetadata object | Definition: EVS disk encryption information. This parameter is mandatory only when the system disk or data disk of the node to be created needs to be encrypted. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| __system__encrypted | String | Details: Whether an EVS disk is encrypted. The value 0 indicates that the EVS disk is not encrypted, and the value 1 indicates that the EVS disk is encrypted. Options: N/A Default value: If this parameter does not appear, the disk is not encrypted. |
| __system__cmkid | String | Details: CMK ID, which indicates encryption in metadata. This field is used with __system__encrypted. Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| storageSelectors | Array of StorageSelectors objects | Definition: Disk selection. Matched disks are managed based on matchLabels and storageType settings. Disks are matched in sequence. The matching rule in the front is matched first. Range: N/A |
| storageGroups | Array of StorageGroups objects | Definition: A storage group consisting of multiple storage devices. It is used to divide storage space. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Name of a selector, which is used as the index of selectorNames in storageGroup. Options: N/A Default value: N/A |
| storageType | String | Details: Storage type name must be cceUse. Options: Only evs (EVS disks), local (local disks), and system (system disks) are supported. Default value: N/A |
| matchLabels | matchLabels object | Details: Matching field of an EVS disk storageType is set to system (system disk), you do not need to configure this parameter. Options: The size, volumeType, metadataEncrypted, metadataCmkid, and count fields in DataVolume are supported. Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| size | String | Details: Matched disk size, for example, 100. If this parameter is left blank, the disk size is not limited. Options: N/A Default value: N/A |
| volumeType | String | Definition EVS disk type. Supported types include SSD, GPSSD, SAS, ESSD, and SATA. If this parameter is left empty, there is no restriction on the EVS disk type. Range N/A |
| metadataEncrypted | String | Details: Disk encryption identifier. If this parameter is set to 0, it specifies that the disk is not encrypted. If this parameter is set to 1, it specifies that the disk is encrypted. If this parameter is left blank, there is no restriction on the disk encryption identifier. Options: N/A Default value: N/A |
| metadataCmkid | String | Details: CMK ID of an encrypted disk. The value is a string of 36 bytes. If this parameter is left blank, there is no restriction on the disk key ID. Options: N/A Default value: N/A |
| count | String | Details: Number of disks to be selected. If this parameter is left blank, all disks of this type are selected. Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Name of a virtual storage group, which must be unique Options:
Default value: N/A |
| cceManaged | Boolean | Details: Storage space to which Kubernetes and runtime belong. Only one group is set to true. If this parameter is left blank, the default value false is used. Options: N/A Default value: N/A |
| selectorNames | Array of strings | Definition: Corresponds to name in storageSelectors. One group can select multiple selectors, but one selector can be selected by only one group. system, only one selector can be selected for a group. Range: N/A |
| virtualSpaces | Array of VirtualSpace objects | Definition: Detailed management of space configurations in a group Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Name of a virtualSpace. Only types of share, kubernetes, runtime, and user are supported. Options:
Default value: N/A |
| size | String | Details: Size of a virtualSpace. The value must be an integer in percentage, for example, 90%. Options: 10 to 90. The sum of percentages of all virtualSpaces in a group cannot exceed 100%. Default value: N/A |
| lvmConfig | LVMConfig object | Definition: LVM configuration management, which is applicable to share, Kubernetes, and user space configuration Range: N/A |
| runtimeConfig | RuntimeConfig object | Definition: Runtime configuration management, which is applicable to runtime space configuration Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| lvType | String | Details: LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance. Options: N/A Default value: N/A |
| path | String | Details: Disk mount path. This parameter only takes effect in user configuration. The value can be an absolute path containing digits, uppercase letters, lowercase letters, periods (.), hyphens (-), and underscores (_). Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| lvType | String | Details: LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance. Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| iptype | String | Details: EIP type, specified in publicip.type in the API for assigning an EIP. For details, see Assigning an EIP. Options: N/A Default value: N/A |
| bandwidth | NodeBandwidth object | Details: Bandwidth parameters of the EIP |
| Parameter | Type | Description |
|---|---|---|
| chargemode | String | Details: Bandwidth billing mode NOTE:
Options:
Default value: N/A |
| size | Integer | Details: Bandwidth size, specified in bandwidth.size in the API for assigning an EIP. For details, see Assigning an EIP. Options: N/A Default value: N/A |
| sharetype | String | Details: Bandwidth sharing type. Dedicated bandwidth is supported only. PER specifies dedicated bandwidth. Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| primaryNic | NicSpec object | Details: Description of the primary ENI |
| extNics | Array of NicSpec objects | Details: Extension ENI |
| Parameter | Type | Description |
|---|---|---|
| key | String | Definition Key of a Kubernetes taint Range N/A |
| value | String | Definition Value of a Kubernetes taint Range N/A |
| effect | String | Definition Effect of a Kubernetes taint Range NoSchedule, PreferNoSchedule, and NoExecute |
| Parameter | Type | Description |
|---|---|---|
| key | String | Details: Key of the cloud server tag CCE-, __type_baremetal, or sys. Options: The value contains a maximum of 128 characters. The tag key must be unique and cannot start or end with a space. It cannot contain non-printable ASCII characters (0–31) or the following special characters: =*<>,|/ Default value: N/A |
| value | String | Details: Value of the cloud server tag Options: The value contains a maximum of 255 characters. The tag value cannot start or end with a space. It cannot contain non-printable ASCII characters (0–31) or the following special characters: =*<>,| Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Container runtime Options: N/A Default value: |
| runtimeClass | String | Definition Container runtime subtype Range |
| Parameter | Type | Description |
|---|---|---|
| ecs:performancetype | String | Definition Type of a cloud server flavor. This field is returned in the response. Range For details about the ECS flavor types, see the description of the ecs:performancetype parameter in the API for listing flavor details and extended information in the ECS API Reference. ] For details, see Listing Flavor Details and Extended Information.] |
| orderID | String | Definition Order ID Range N/A |
| productID | String | Definition Product ID Range N/A |
| maxPods | Integer | Definition The maximum number of pods that can be created on a node, including the default system pods. This limit prevents the node from being overloaded with pods. The number of pods that can be created on a node is determined by multiple parameters. For details, see Maximum Number of Pods That Can Be Created on a Node. Range Typically, the value ranges from 16 to 256. For nodes using secure runtime v2 (kuasar-vmm), the value ranges from 16 to 1024. |
| periodType | String | Details: Subscription term unit billingMode is set to 1 (yearly/monthly billing) or 2 (yearly/monthly billing with auto payment enabled) (This option has been deprecated). Options: Default value: N/A |
| periodNum | Integer | Details: Number of subscription periods billingMode is set to 1 (yearly/monthly billing) or 2 (yearly/monthly billing with auto payment enabled) (This option has been deprecated). Options: Default value: N/A |
| isAutoRenew | String | Details: Whether auto-renewal is enabled billingMode is set to 1 or 2 (deprecated). If not specified, auto-renewal is not enabled. Options: Default value: N/A |
| isAutoPay | String | Details: Whether an order is automatically or manually paid billingMode is set to 1 or 2 (deprecated). If not specified when billingMode is set to 1, auto payment is not enabled. If not specified when billingMode is set to 2 (deprecated), auto payment is enabled. Options: Default value: N/A |
| DockerLVMConfigOverride | String | Details: Docker data disk configuration item. (This parameter has been deprecated. Use the storage field instead.) Example of the default configuration: "DockerLVMConfigOverride":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear" By default, if no VD disk is available, an error occurs because the data disk fails to be found. Specify diskType based on the actual drive letter type. Options: The following fields are included:
Default value: N/A |
| dockerBaseSize | Integer | Definition Available disk space of a single container on a node (unit: G). This parameter has been deprecated. Use containerBaseSize. For details about how to allocate the space for the container runtime, see Data Disk Space Allocation. dockerBaseSize be set to a value less than or equal to 80 GiB. If the value is too large, the container runtime may fail to be started due to time-consuming initialization. If there are special requirements for the container disk space, you can mount external or local storage.
Range 10 to 500 0, the default value is used. |
| containerBaseSize | Integer | Details: Available disk space of a single container on a node (unit: G). For details about how to allocate the space for the container runtime, see Space Allocation of a Data Disk. containerBaseSize be set to a value less than or equal to 80 GiB. If the value is too large, the container runtime may fail to be started due to long initialization. If there are special requirements for the container disk space, you can mount 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 deprecated.
Options: 10 to 500 Default value: If the value is not specified or is set to 0, the default value is used. |
| publicKey | String | Definition Public key of a node, which is used for SSH key login Range N/A |
| alpha.cce/preInstall | String | Details: Pre-installation script. The input value must be encoded using Base64. The method is as follows: echo -n "*Content to be encoded*" | base64 Options: N/A Default value: N/A |
| alpha.cce/postInstall | String | Details: Post-installation script. The input value must be encoded using Base64. The method is as follows: echo -n "*Content to be encoded*" | base64 Options: N/A Default value: N/A |
| alpha.cce/NodeImageID | String | Definition Private image ID of a node, which is obtained from the IMS console. This parameter is required when private images are used. Range N/A |
| chargingMode | Integer | Details: Billing mode of a node. This parameter has been deprecated. Use billingMode in NodeSpec instead. Options: N/A Default value: N/A |
| marketType | String | Details: When creating a spot ECS, this parameter should be set to spot. billingMode is set to 0. Options: N/A Default value: N/A |
| spotPrice | String | Details: The highest price per hour a user accepts for a spot ECS billingMode is set to 0 and marketType is set to spot.
Options: N/A Default value: N/A |
| agency_name | String | Details: Agency name. 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. Options: N/A Default value: N/A |
| kubeReservedMem | Integer | Details: Reserved node memory, which is reserved for Kubernetes components. Options: N/A Default value: N/A |
| systemReservedMem | Integer | Details: Reserved node memory, which is reserved for system components. Options: N/A Default value: N/A |
| kubeReservedCpu | Integer | Definition Reserved node CPU cores for Kubernetes components. The unit is mcore. kubeReservedCpu and systemReservedCpu is less than 50/ %of the minimum CPUs of the nodes in a node pool. Range N/A |
| systemReservedCpu | Integer | Definition Reserved node CPU cores for system components. The unit is mcore. kubeReservedCpu and systemReservedCpu is less than 50/ %of the minimum CPUs of the nodes in a node pool. Range N/A |
| kubeReservedPid | Integer | Definition Reserved node PIDs for Kubernetes components. The purpose is to reserve a specified number of PIDs for Kubernetes daemons, such as kubelet and container runtime. kubeReservedPid and systemReservedPid is less than 50/ %of the maximum number of Linux PIDs. Range [0,2097152] Note: CCE verifies only the scenario where kernel.pid_max is 4194304. The kernel.pid_max of nodes created on or before January 30, 2022 is different from that of some OSs. If you have updated kernel.pid_max, ensure that the sum of kubeReservedPid and systemReservedPid is less than the upper limit of the number of Linux PIDs. |
| systemReservedPid | Integer | Definition Reserved node PIDs for system components. The purpose is to reserve a specified number of PIDs for the OS daemons, such as sshd and udev. kubeReservedPid and systemReservedPid is less than 50/ %of the maximum number of Linux PIDs. Range [0,2097152] Note: CCE verifies only the scenario where kernel.pid_max is 4194304. The kernel.pid_max of nodes created on or before January 30, 2022 is different from that of some OSs. If you have updated kernel.pid_max, ensure that the sum of kubeReservedPid and systemReservedPid is less than the upper limit of the number of Linux PIDs. |
| kubeReservedStorage | Integer | Definition Reserved temporary storage space of a node for Kubernetes components. The unit is Gi. The purpose is to reserve temporary storage for Kubernetes daemons, such as kubelet and container runtime. kubeReservedStorage and systemReservedStorage is less than 50/ %of the disk space used by container components. Range N/A |
| systemReservedStorage | Integer | Definition Reserved temporary storage space of a node for system components. The unit is Gi. The purpose is to reserve temporary storage for OS daemons, such as sshd and udev. kubeReservedStorage and systemReservedStorage is less than 50/ %of the disk space used by container components. Range N/A |
| init-node-password | String | Definition Node password. If this parameter is used only in a response, asterisks (*) are displayed. It is not returned in the responses related to node pools. Range N/A |
| serverMetadataHttpTokens | String | Definition Whether a token is required. The default value is optional. Range |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Component name Options: N/A Default value: N/A |
| configurations | Array of ConfigurationItem objects | Details: Component configuration items |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition: Component configuration parameters. For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations. Options: N/A Default value: N/A |
| value | Object | Definition: Values of component configuration parameters. For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations. Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| nodeNamePrefix | String | Definition Node name prefix. If this parameter is left empty or set to the default value, no prefix will be added to the node name. Range N/A |
| nodeNameSuffix | String | Definition Node name suffix. If this parameter is left empty or set to the default value, no suffix will be added to the node name. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| enable | Boolean | Details: Whether to enable auto scaling Options: Default value: false |
| minNodeCount | Integer | Details: Minimum number of nodes that can be scaled in if auto scaling is enabled Options: Values that are greater than or equal to 0 and cannot be greater than the maximum number of nodes allowed by the cluster specifications Default value: 0 |
| maxNodeCount | Integer | Details: Maximum number of nodes that can be added if auto scaling is enabled Options: Values that are greater than or equal to the value of minNodeCount and cannot be greater than the maximum number of nodes allowed by the cluster specifications Default value: 0 |
| scaleDownCooldownTime | Integer | Details: How long nodes will be kept, in minutes. During this period, nodes added will not be deleted. Options: 0 to 2147483646 Default value: 0 |
| priority | Integer | Details: Weight of a node pool. A node pool with a higher weight has a higher priority during scale-out. Options: N/A Default value: 0 |
| scaleDownUnneededTime | Integer | Details: How long a node should be unneeded before it is eligible for scale in. This parameter specifies the duration during which a node is in the unneeded state before the scale-in operation can be performed. CCE Cluster Autoscaler scales in the node only when the node is not needed for a specified period. This prevents frequent scale-in triggered by temporary resource fluctuations and improves system stability. If this parameter is not specified, the CCE Cluster Autoscaler add-on uses the default time threshold. Options: 0 to 2147483647 NOTE: Note: If the parameter is set to -1, it indicates that the value is empty. Default value: This parameter is left empty by default. |
| scaleDownUtilizationThreshold | Float | Details: Scale-in utilization threshold of a node, which is defined by the total CPU or memory resources used by all running pods on the node divided by the total available resources of the node. If the calculated value falls below the specified threshold, the node becomes eligible for scale-in. For example, setting this parameter to 0.3 means that if the resource utilization on a node drops below 30%, the node will be scaled in. If this parameter is not specified, the CCE Cluster Autoscaler add-on will use the default utilization threshold. Options: 0 to 1 NOTE: Note: If the parameter is set to -1, it indicates that the value is empty. Default value: This parameter is left empty by default. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition ID of the container security group on a node Range N/A |
| Parameter | Type | Description |
|---|---|---|
| metadata | ExtensionScaleGroupMetadata object | Details: Basic information about an extended scaling group |
| spec | ExtensionScaleGroupSpec object | Details: Configurations of an extended scaling group, which carry different configurations from those of the default scaling group |
| Parameter | Type | Description |
|---|---|---|
| uid | String | Definition Extended scaling group UUID. Range N/A |
| name | String | Details: Name of an extended scaling group default. Options: Enter 1 to 56 characters starting with a lowercase letter and ending with a lowercase letter or digit. Only digits, lowercase letters, and hyphens (-) are allowed. Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| flavor | String | Details: Node flavors. For details about the node flavors supported by CCE clusters, see Node Specifications. Options: N/A Default value: N/A |
| az | String | Details: Node AZ Options: N/A Default value: If this parameter is not specified or left blank, the default scaling group configurations take effect. |
| capacityReservationSpecification | Details: Capacity reservation configurations of an extended scaling group | |
| autoscaling | ScaleGroupAutoscaling object | Details: Auto scaling configurations of an extended scaling group |
| Parameter | Type | Description |
|---|---|---|
| id | String | Details: Private pool ID preference is set to none. Options: N/A Default value: N/A |
| preference | String | Details: Private pool capacity 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. Options: N/A Default value: none |
| Parameter | Type | Description |
|---|---|---|
| enable | Boolean | Details: Whether to enable auto scaling for a scaling group Options: Default value: false |
| extensionPriority | Integer | Details: Scaling group priority. A larger value indicates a higher priority. Options: N/A Default value: 0 |
| minNodeCount | Integer | Details: Minimum number of nodes that can be kept in a scaling group during auto scaling Options: Values that are greater than or equal to 0 and cannot be greater than the maximum number of nodes allowed by the cluster specifications Default value: 0 |
| maxNodeCount | Integer | Details: Maximum number of nodes that can be kept in a scaling group during auto scaling Options: Values that are greater than or equal to the value of minNodeCount, less than or equal to the maximum number of nodes allowed by the cluster specifications, and less than or equal to the maximum number of nodes in the node pool Default value: 0 |
| Parameter | Type | Description |
|---|---|---|
| currentNode | Integer | Details: Total number of nodes in the current node pool (excluding the nodes that are being deleted) Options: N/A Default value: N/A |
| creatingNode | Integer | Details: Number of nodes that are being created in the current node pool Options: N/A Default value: N/A |
| deletingNode | Integer | Details: Number of nodes that are being deleted in the current node pool Options: N/A Default value: N/A |
| activeNode | Integer | Definition Number of ready nodes in the current node pool Range N/A |
| configurationSyncedNodeCount | Integer | Details: The number of nodes specified in the node pool configuration has been synchronized in the current node pool. Options: None Default value: N/A |
| phase | String | Details: Node pool status Options:
NOTE: The preceding node pool statuses have been deprecated. They are reserved only for compatibility. Do not use them anymore. Use the following instead: Default value: N/A |
| jobId | String | Details: ID of a job executed on the node pool Options: N/A Default value: N/A |
| conditions | Array of NodePoolCondition objects | Details: Details of node pool statuses. For details, see the definition of Condition. |
| scaleGroupStatuses | Array of ScaleGroupStatus objects | Details: Detailed status of a scaling group. For details, see the definition of ScaleGroupStatus. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Details: Scaling group name Options: N/A Default value: N/A |
| uid | String | Details: Scaling group UUID Options: N/A Default value: N/A |
| creationTimestamp | String | Details: The time when a scaling group was created Options: N/A Default value: N/A |
| updateTimestamp | String | Details: The time when a scaling group was updated Options: N/A Default value: N/A |
| phase | String | Details: Scaling group status Options:
NOTE: The preceding scaling group status has been deprecated. It is reserved only for compatibility. Do not use it anymore. Use the following instead:
Default value: N/A |
| desiredNodeCount | Integer | Details: Expected number of nodes in a scaling group Options: N/A Default value: N/A |
| unpaidScaleNodeCount | Integer | Details: Number of nodes in an unpaid order Options: N/A Default value: N/A |
| activeNodeCount | Integer | Definition Number of ready nodes in a scaling group Range N/A |
| existingNodeCount | existingNodeCount object | Details: Statistics on existing nodes in a scaling group |
| upcomingNodeCount | upcomingNodeCount object | Details: Statistics on the nodes to be added in a scaling group |
| scaleDownDisabledNodeCount | Integer | Details: Number of nodes that cannot be deleted in a scaling group Options: N/A Default value: N/A |
| conditions | Array of NodePoolCondition objects | Details: Scaling group status details. For details, see the definition of Condition. |
| Parameter | Type | Description |
|---|---|---|
| postPaid | Integer | Details: Number of pay-per-use nodes Options: N/A Default value: N/A |
| prePaid | Integer | Details: Number of yearly/monthly nodes Options: N/A Default value: N/A |
| total | Integer | Details: Total number of pay-per-use and yearly/monthly nodes Options: N/A Default value: N/A |
| Parameter | Type | Description |
|---|---|---|
| postPaid | Integer | Details: Number of pay-per-use nodes Options: N/A Default value: N/A |
| prePaid | Integer | Details: Number of yearly/monthly nodes Options: N/A Default value: N/A |
| total | Integer | Details: Total number of pay-per-use and yearly/monthly nodes Options: N/A Default value: N/A |
Example Requests
None
Example Responses
Status code: 200
The job for deleting the node pool 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" : {
"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 DeleteNodePoolSolution { 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(); DeleteNodePoolRequest request = new DeleteNodePoolRequest(); request.withClusterId("{cluster_id}"); request.withNodepoolId("{nodepool_id}"); try { DeleteNodePoolResponse response = client.deleteNodePool(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 = DeleteNodePoolRequest() request.cluster_id = "{cluster_id}" request.nodepool_id = "{nodepool_id}" response = client.delete_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 40 41 42 43 44 45 46 47 48 49 50 51 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.DeleteNodePoolRequest{} request.ClusterId = "{cluster_id}" request.NodepoolId = "{nodepool_id}" response, err := client.DeleteNodePool(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 | The job for deleting the node pool is successfully delivered. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot