All Products
Search
Document Center

Container Service for Kubernetes:ModifyClusterNodePool

Last Updated:Jan 23, 2024

You can call the ModifyClusterNodePool operation to modify the configuration of a node pool.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:ModifyClusterNodePoolWrite
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

PUT /clusters/{ClusterId}/nodepools/{NodepoolId}

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c23421cfa74454bc8b37163fd19af****
NodepoolIdstringYes

The node pool ID.

p31da1b38983f4511b490fc62108a****
bodyobjectNo

The request body.

auto_scalingobjectNo

The configuration of auto scaling.

eip_bandwidthlongNo

The maximum bandwidth of the elastic IP address (EIP).

5
eip_internet_charge_typestringNo

The metering method of the EIP. Valid values:

  • PayByBandwidth: pay-by-bandwidth.
  • PayByTraffic: pay-by-data-transfer.

Default value: PayByBandwidth.

PayByBandwidth
enablebooleanNo

Specifies whether to enable auto scaling. Valid values:

  • true: enables auto scaling for the node pool.
  • false: disables auto scaling for the node pool. If you set this parameter to false, other parameters in the auto_scaling section do not take effect.

Default value: false.

true
is_bond_eipbooleanNo

Specifies whether to associate an EIP with the node pool. Valid values:

  • true: associates an EIP with the node pool.
  • false: does not associate an EIP with the node pool.

Default value: false.

true
max_instanceslongNo

The maximum number of Elastic Compute Service (ECS) instances that can be created in the node pool.

10
min_instanceslongNo

The minimum number of ECS instances that must be kept in the node pool.

2
typestringNo

The instance types that can be used for the auto scaling of the node pool. Valid values:

  • cpu: regular instance.
  • gpu: GPU-accelerated instance.
  • gpushare: shared GPU-accelerated instance.
  • spot: preemptible instance

Default value: cpu.

cpu
kubernetes_configobjectNo

The configuration of the cluster where the node pool is deployed.

cms_enabledbooleanNo

Specifies whether to install the CloudMonitor agent on ECS nodes. After the CloudMonitor agent is installed on ECS nodes, you can view monitoring information about the instances in the CloudMonitor console. We recommend that you install the CloudMonitor agent. Valid values:

  • true: installs the CloudMonitor agent on ECS nodes.
  • false: does not install the CloudMonitor agent on ECS nodes.

Default value: false.

true
cpu_policystringNo

The CPU management policy of the nodes in the node pool. The following policies are supported if the Kubernetes version of the cluster is 1.12.6 or later.

  • static: allows pods with specific resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.
  • none: specifies that the default CPU affinity is used.

Default value: none.

none
labelsarrayNo

The labels of the nodes in the node pool. You can add labels to the nodes in the cluster. You must add labels based on the following rules:

  • Each label is a case-sensitive key-value pair. You can add at most 20 labels.
  • The key must be unique and cannot exceed 64 characters in length. The value can be empty and cannot exceed 128 characters in length. Keys and values cannot start with aliyun, acs:, https://, or http://. For more information, see Labels and Selectors.
tagNo

The node label.

runtimestringNo

The name of the container runtime.

docker
runtime_versionstringNo

The version of the container runtime.

19.03.5
taintsarrayNo

The configurations of node taints.

taintNo

The configurations of node taints.

user_datastringNo

The user-defined data of the node pool. For more information, see Prepare user data.

IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
nodepool_infoobjectNo

The configurations of the node pool.

namestringNo

The name of the node pool.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).

default-nodepool
resource_group_idstringNo

The ID of the resource group to which the node pool belongs.

rg-acfmyvw3wjm****
scaling_groupobjectNo

The configurations of the scaling group.

data_disksarrayNo

The configurations of the data disks that are mounted to the nodes in the node pool. You can mount 0 to 10 data disks. You can mount at most 10 data disks to the nodes in the node pool.

data_diskNo

The configuration of node data disks.

instance_charge_typestringNo

The billing method of the nodes in the node pool. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go.

Default value: PostPaid.

PostPaid
periodlongNo

The subscription duration of worker nodes. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

If PeriodUnit=Month is specified, the valid values are 1, 2, 3, 6, 12, 24, 36, 48, and 60.

1
period_unitstringNo

The billing cycle of the nodes in the node pool. This parameter is required if you set instance_charge_type to PrePaid.

The billing cycle is measured only in months.

Default value: Month.

Month
auto_renewbooleanNo

Specifies whether to enable auto-renewal for the nodes in the node pool. This parameter takes effect only when you set instance_charge_type to PrePaid. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.

Default value: true.

true
auto_renew_periodlongNo

The duration of the auto-renewal. This parameter takes effect and is required only when you set instance_charge_type to PrePaid.

If you specify PeriodUnit=Month, the valid values are 1, 2, 3, 6, and 12.

1
platformstringNo

The operating system. Valid values:

  • AliyunLinux
  • CentOS
  • Windows
  • WindowsCore
AliyunLinux
image_idstringNo

The ID of the custom image. You can call the DescribeKubernetesVersionMetadata operation to query the supported images. By default, the latest image is used.

aliyun_2_1903_x64_20G_alibase_20200904.vhd
spot_strategystringNo

The bidding policy of preemptible instances. Valid values:

  • NoSpot: non-preemptible instance.
  • SpotWithPriceLimit: specifies the highest bid for the preemptible instance.
  • SpotAsPriceGo: automatically submits bids based on the up-to-date market price.

For more information, see Preemptible instances.

SpotWithPriceLimit
spot_price_limitobject []No

The bid configurations of preemptible instances.

instance_typestringNo

The instance type of preemptible instances.

ecs.c6.large
price_limitstringNo

The maximum bid price of a preemptible instance.

Unit: USD/hour.

0.39
instance_typesarrayNo

A list of instance types. You can select multiple instance types. When the system needs to create a node, it starts from the first instance type until the node is created. The instance type that is used to create the node varies based on the actual instance stock.

stringNo

The type of instance. For more information, see Overview of instance families.

ecs.c6.large
key_pairstringNo

The name of the key pair. You must set this parameter or the login_password parameter. You must set key_pair if the node pool is a managed node pool.

pro-nodepool
login_passwordstringNo

The password for SSH logon. You must set this parameter or the key_pair parameter. The password must be 8 to 30 characters in length, and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

Hello1234
rds_instancesarrayNo

A list of ApsaraDB RDS instances.

stringNo

The IDs of ApsaraDB RDS instances. After you specify the list of RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the RDS instances.

rds-xxx
scaling_policystringNo

The scaling mode of the scaling group. Valid values:

  • release: the standard mode. ECS instances are created and released based on resource usage.
  • recycle: the swift mode. ECS instances are created, stopped, or started during scaling events. This reduces the time required for the next scale-out event. When the instance is stopped, you are charged only for the storage service. This does not apply to ECS instances that are attached with local disks.
release
system_disk_categorystringNo

The type of system disk. Valid values:

  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD.

Default value: cloud_ssd.

cloud_efficiency
system_disk_sizelongNo

The system disk size of a node. Unit: GiB.

Valid values: 20 to 500.

The value of this parameter must be at least 20 and greater than or equal to the size of the specified image.

The default value is the greater one between 40 and the image size.

120
system_disk_performance_levelstringNo

The performance level (PL) of the system disk that you want to use for the node. This parameter takes effect only for enhanced SSDs. You can specify a higher PL if you increase the size of the system disk. For more information, see ESSDs .

PL1
tagsarrayNo

The labels that you want to add to the ECS instances.

The key must be unique and cannot exceed 128 characters in length. Neither keys nor values can start with aliyun or acs:. Neither keys nor values can contain https:// or http://.

tagNo

The label to be added to the ECS instances.

vswitch_idsarrayNo

The vSwitch IDs. You can specify 1 to 20 vSwitches.

Note To ensure high availability, we recommend that you select vSwitches in different zones.
stringNo

The ID of the vSwitch that is associated with the specified VPC.

vsw-wz9uwxhawmtzg7u9h****
multi_az_policystringNo

The ECS instance scaling policy for a multi-zone scaling group. Valid values:

  • PRIORITY: The scaling group is scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone where the vSwitch that has the next highest priority resides.

  • COST_OPTIMIZED: ECS instances are created based on the vCPU unit price in ascending order. Preemptible instances are preferably created when preemptible instance types are specified in the scaling configuration. You can set the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources.

    **

    Note COST_OPTIMIZED is valid only when multiple instance types are specified or at least one preemptible instance type is specified.

  • BALANCE: ECS instances are evenly distributed across multiple zones specified by the scaling group. If ECS instances become imbalanced among multiple zones due to insufficient inventory, you can call the RebalanceInstances operation of Auto Scaling to balance the instance distribution among zones. For more information, see RebalanceInstances .

Default value: PRIORITY.

BALANCE
on_demand_base_capacitylongNo

The minimum number of pay-as-you-go instances that must be kept in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.

0
on_demand_percentage_above_base_capacitylongNo

The percentage of pay-as-you-go instances among the extra instances that exceed the number specified by on_demand_base_capacity. Valid values: 0 to 100.

20
spot_instance_poolslongNo

The number of instance types that are available for creating preemptible instances. Auto Scaling creates preemptible instances of multiple instance types that are available at the lowest cost. Valid values: 1 to 10.

5
spot_instance_remedybooleanNo

Specifies whether to supplement preemptible instances. If this parameter is set to true, when the scaling group receives a system message that a preemptible instance is to be reclaimed, the scaling group attempts to create a new instance to replace this instance. Valid values:

  • true: enables the supplementation of preemptible instances.
  • false: disables the supplementation of preemptible instances.
false
compensate_with_on_demandbooleanNo

Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created due to reasons such as the cost or insufficient inventory. This parameter takes effect when you set multi_az_policy to COST_OPTIMIZED. Valid values:

  • true: automatically creates pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.
  • false: does not create pay-as-you-go instances to meet the required number of ECS instances if preemptible instances cannot be created.
true
internet_charge_typestringNo

The metering method of the public IP address. Valid values:

  • PayByBandwidth: pay-by-bandwidth.
  • PayByTraffic: pay-by-data-transfer.
PayByBandwidth
internet_max_bandwidth_outlongNo

The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.

5
desired_sizelongNo

The expected number of nodes in the node pool.

2
private_pool_optionsobjectNo

The configuration of the private node pool.

idstringNo

The ID of the private node pool.

eap-bp67acfmxazb4****
match_criteriastringNo

The type of private node pool. This parameter specifies the type of private node pool that you want to use to create instances. A private node pool is generated when an elasticity assurance or a capacity reservation service takes effect. The system selects a private node pool to launch instances. Valid values:

  • Open: specifies an open private node pool. The system selects an open private node pool to launch instances. If no matching open private node pool is available, the resources in the public node pool are used.
  • Target: specifies a private node pool. The system uses the resources of the specified private node pool to launch instances. If the specified private node pool is unavailable, instances cannot be launched.
  • None: no private node pool is used. The resources of private node pools are not used to launch the instances.
Open
tee_configobjectNo

The configurations about confidential computing for the cluster.

tee_enablebooleanNo

Specifies whether to enable confidential computing for the cluster. Valid values:

  • true: enables confidential computing for the cluster.
  • false: disables confidential computing for the cluster.

Default value: false.

false
managementobjectNo

The configuration of the managed node pool feature.

enablebooleanNo

Specifies whether to enable the managed node pool feature. Valid values:

  • true: enables the managed node pool feature.
  • false: disables the managed node pool feature. Other parameters in this section take effect only when enable=true is specified.

Default value: false.

true
auto_repairbooleanNo

Specifies whether to enable auto repair. This parameter takes effect only when you specify enable=true. Valid values:

  • true: enables auto repair.
  • false: disables auto repair.

Default value: true.

true
upgrade_configobjectNo

The configuration of auto update. The configuration takes effect only when enable=true is specified.

auto_upgradebooleanNo

Specifies whether to enable auto update.

  • true: enables auto update.
  • false: disables auto update.

Default value: true.

true
surgelongNo

The number of nodes that are temporarily added to the node pool during an auto update. Additional nodes are used to host the workloads of nodes that are being updated.

Note We recommend that you set the number of additional nodes to a value that does not exceed the current number of existing nodes.
5
surge_percentagelongNo

The percentage of additional nodes to the nodes in the node pool. You must set this parameter or surge.

0
max_unavailablelongNo

The maximum number of nodes that can be in the Unavailable state.

Valid values: 1 to 1000.

Default value: 1.

1
auto_repair_policyobjectNo

The auto node repair policy.

restart_nodebooleanNo

Specifies whether ACK is allowed to automatically restart nodes after patching CVE vulnerabilities. Valid values:

  • true: yes
  • false: no
true
auto_vul_fixbooleanNo

Specifies whether ACK is allowed to automatically patch CVE vulnerabilities. Valid values:

  • true: yes
  • false: no
true
auto_vul_fix_policyobjectNo

The auto CVE patching policy.

restart_nodebooleanNo

Specifies whether ACK is allowed to automatically restart nodes after patching CVE vulnerabilities. Valid values:

  • true: yes
  • false: no
true
vul_levelstringNo

The severity levels of vulnerabilities that ACK is allowed to automatically patch. Multiple severity levels are separated by commas (,).

asap,nntf
auto_upgradebooleanNo

Specifies whether to enable auto update. Valid values:

  • true: enables auto update.
  • false: disables auto update.
true
auto_upgrade_policyobjectNo

The auto update policy.

auto_upgrade_kubeletbooleanNo

Specifies whether ACK is allowed to automatically update the kubelet. Valid values:

  • true: yes
  • false: no
true
update_nodesbooleanNo

Specifies whether to update node information, such as labels and taints.

true

Response parameters

ParameterTypeDescriptionExample
object

The response body.

task_idstring

The task ID.

T-5fd211e924e1d00787000293
nodepool_idstring

The node pool ID.

np737c3ac1ac684703b9e10673aa2c****

Examples

Sample success responses

JSONformat

{
  "task_id": "T-5fd211e924e1d00787000293",
  "nodepool_id": "np737c3ac1ac684703b9e10673aa2c****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-12-15The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-13The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-10-17The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-30The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-10The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2020-09-23The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.