ModifyClusterNodePool - Container Service for Kubernetes

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

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.

Operation	Access level	Resource type	Condition key	Associated operation
cs:ModifyClusterNodePool	update	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c23421cfa74454bc8b37163fd19af****
NodepoolId	string	Yes	The node pool ID.	p31da1b38983f4511b490fc62108a****
body	object	No	The request body parameters.
nodepool_info	object	No	The configurations of the node pool.
name	string	No	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_id	string	No	The resource group ID.	rg-acfmyvw3wjm****
auto_scaling	object	No	The configuration of auto scaling.
enable	boolean	No	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
type`deprecated`	string	No	The instance type that is used for auto scaling. Valid values: `cpu`: regular instance. `gpu`: GPU-accelerated instance. `gpushare`: shared GPU-accelerated instance. `spot`: preemptible instance. Default value: `cpu`.	cpu
max_instances	long	No	The maximum number of Elastic Compute Service (ECS) instances that can be created in the node pool.	10
min_instances	long	No	The minimum number of ECS instances that must be kept in the node pool.	2
is_bond_eip`deprecated`	boolean	No	Specifies whether to associate an EIP with the node pool. Valid values: `true`: associates an EIP with the node pool. `false`: No EIP is associated with the node pool. Default value: `false`.	true
eip_internet_charge_type`deprecated`	string	No	The metering method of the elastic IP address (EIP). Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-data-transfer. Default value: `PayByBandwidth`.	PayByBandwidth
eip_bandwidth`deprecated`	long	No	The maximum bandwidth of the EIP.	5
management	object	No	The configurations of the managed node pool feature.
enable	boolean	No	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_repair	boolean	No	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
auto_repair_policy	object	No	The auto node repair policy.
restart_node	boolean	No	Specifies whether to allow node restart. Valid values: `true`: allows node restart. `false`: does not allow node restart.	true
auto_vul_fix	boolean	No	Specifies whether to enable auto Common Vulnerabilities and Exposures (CVE) patching. Valid values: `true`: enables auto CVE patching. `true`: disables auto CVE patching.	true
auto_vul_fix_policy	object	No	The auto CVE patching policy.
restart_node	boolean	No	Specifies whether to allow node restart. Valid values: `true`: allows node restart. `false`: does not allow node restart.	true
vul_level	string	No	The severity levels of CVEs that can be automatically patched. Separate multiple levels with commas (,).	asap,nntf
auto_upgrade	boolean	No	Specifies whether to enable auto update. Valid values: `true`: enables auto update. `false`: disables auto update.	true
auto_upgrade_policy	object	No	The auto update policy.
auto_upgrade_kubelet	boolean	No	Specifies whether to allow auto update of the kubelet. Valid values: `true`: allows auto update of the kubelet. `false`: does not allow auto update of the kubelet.	true
auto_upgrade_runtime	boolean	No	Specifies whether to allow auto update of the runtime. This parameter takes effect only when you specify `auto_upgrade=true`. Valid values: `true`: allows auto update of the runtime. `false`: does not allow auto update of the runtime. Default value: `false`.
auto_upgrade_os	boolean	No	Specifies whether to allow auto update of the OS. This parameter takes effect only when you specify `auto_upgrade=true`. Valid values: `true`: allows auto update of the OS. `false`: does not allow auto update of the OS. Default value: `false`.
upgrade_config`deprecated`	object	No	The configurations of auto update. The configuration takes effect only when you specify `enable=true`.
auto_upgrade`deprecated`	boolean	No	Specifies whether to enable auto update. Valid values: true: enables auto update. false: disables auto update. Default value: `true`.	true
surge	long	No	The number of additional nodes that are temporarily added to the node pool during an auto update. A node is unavailable during an update. Additional nodes are used to temporarily 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 in the node pool.	5
surge_percentage	long	No	The percentage of additional nodes that are temporarily added to the node pool during an auto update. You must set this parameter or `surge`.	0
max_unavailable	long	No	The maximum number of unavailable nodes. Valid values: 1 to 1000. Default value: 1.	1
scaling_group	object	No	The configurations of the scaling group that is used by the node pool.
vswitch_ids	array	No	The vSwitch IDs. You can specify 1 to 20 vSwitches. Note To ensure high availability, we recommend that you select vSwitches that reside in different zones.
	string	No	The vSwitch IDs.	vsw-wz9uwxhawmtzg7u9h****
instance_types	array	No	The instance types of nodes in the node pool. When the system adds a node to the node pool, the system selects the most appropriate one from the specified instance types for the node. The instance type that is used to create the node varies based on the actual instance stock.
	string	No	The instance type. For more information, see Overview of ECS instance families.	ecs.c6.large
instance_charge_type	string	No	The billing method of nodes in the node pool. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go. Default value: `PostPaid`.	PostPaid
period	long	No	The subscription duration of nodes in the node pool. This parameter takes effect and is required if you set `instance_charge_type` to `PrePaid`. If `PeriodUnit=Month` is specified, the valid values are 1, 2, 3, 6, 12, 24, 36, 48, and 60.	1
period_unit	string	No	The billing cycle of nodes in the node pool. This parameter is required if you set `instance_charge_type` to `PrePaid`. Valid values: The billing cycle is measured only in months. Default value: `Month`.	Month
auto_renew	boolean	No	Specifies whether to enable auto-renewal for 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_period	long	No	The auto-renewal duration of nodes in the node pool. 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
spot_strategy	string	No	The bidding policy of preemptible instances. Valid values: `NoSpot`: non-preemptible instance. `SpotWithPriceLimit`: specifies the highest bid. `SpotAsPriceGo`: automatically submits bids based on the up-to-date market price. For more information, see Preemptible instances.	SpotWithPriceLimit
spot_price_limit	array<object>	No	The instance type of preemptible instances and the price cap for the instance type.
	object	No	The instance type of preemptible instances and the price cap for the instance type.
instance_type	string	No	The price cap of a preemptible instance.	ecs.c6.large
price_limit	string	No	The price cap of a preemptible instance. Unit: USD/hour.	0.39
image_type	string	No	The type of OS distribution that you want to use. To specify the node OS, we recommend that you use this parameter. Valid values: `AliyunLinux`: Alibaba Cloud Linux 2. `AliyunLinuxSecurity`: Alibaba Cloud Linux 2 (UEFI). `AliyunLinux3`: Alibaba Cloud Linux 3 `AliyunLinux3Arm64`: Alibaba Cloud Linux 3 (ARM). `AliyunLinux3Security`: Alibaba Cloud Linux 3 (UEFI). `CentOS`: CentOS. `Windows`: Windows. `WindowsCore`: Windows Core. `ContainerOS`: ContainerOS.	AliyunLinux
image_id	string	No	The custom image ID. You can call the `DescribeKubernetesVersionMetadata` operation to query the supported images. By default, the latest image provided by the system is used.	aliyun_2_1903_x64_20G_alibase_20200904.vhd
system_disk_category	string	No	The system disk type. Valid values: `cloud_efficiency`: ultra disk. `cloud_ssd`: standard SSD. Default value: `cloud_ssd`.	cloud_efficiency
system_disk_categories	array	No	The system disk types. The system creates system disks of a disk type with a lower priority if the disk type with a higher priority is unavailable. Valid values: cloud (basic disk), cloud_efficiency (ultra disk), cloud_ssd (standard SSD), and cloud_essd: (ESSD).
	string	No	The system disk type.	cloud_essd
system_disk_size	long	No	The size of the system disk. Unit: GiB. Valid values: 20 to 500. The value of this parameter must be at least 20 and greater than or equal to the image size. Default value: the greater value between 40 and the image size.	120
system_disk_performance_level	string	No	The performance level (PL) of the system disk. This parameter takes effect only for an Enterprise SSD (ESSD). You can specify a higher PL if you increase the size of the data disk. For more information, see ESSDs .	PL1
system_disk_encrypted	boolean	No	Specifies whether to encrypt the system disk. Valid values: true: encrypts the system disk. false: does not encrypt the system disk.	false
system_disk_kms_key_id	string	No	The ID of the Key Management Service (KMS) key that is used to encrypt the system disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	No	The encryption algorithm that is used to encrypt the system disk. Set the value to aes-256.	aes-256
system_disk_provisioned_iops	long	No	The preset read/write IOPS of the system disk when the disk type is cloud_auto.	1000
system_disk_bursting_enabled	boolean	No	Specifies whether to enable the burst feature for the system disk when the disk type is cloud_auto.	true
data_disks	array	No	The configurations of the data disks that are mounted to nodes in the node pool. Valid values: 0 to 10. You can mount at most 10 data disks to nodes in the node pool.
	data_disk	No	The configuration of the data disk.
key_pair	string	No	The name of the key pair. You must specify this parameter or the `login_password` parameter. You must specify the `key_pair` parameter if the node pool is a managed node pool.	pro-nodepool
login_password	string	No	The password for SSH logon. You must specify 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
internet_charge_type	string	No	The metering method of the public IP address. Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-data-transfer.	PayByBandwidth
internet_max_bandwidth_out	long	No	The maximum outbound bandwidth of the public IP address. Unit: Mbit/s. Valid values: 1 to 100.	5
tags	array	No	The labels that you want to add only to ECS instances. The label key must be unique and cannot exceed 128 characters in length. The label key and value cannot start with aliyun or acs: and cannot contain https:// or http://.
	tag	No	The label.
desired_size	long	No	The expected number of nodes in the node pool.	2
multi_az_policy	string	No	The ECS instance scaling policy for the multi-zone scaling group. Valid values: `PRIORITY`: ECS instances are scaled based on the VSwitchIds.N parameter. If an ECS instance cannot be created in the zone in which the vSwitch that has the highest priority resides, Auto Scaling creates the ECS instance in the zone in which 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 configurations. You can set `CompensateWithOnDemand` to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient inventory. 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 evenly distribute the ECS instances among zones. For more information, see RebalanceInstances . Default value: `PRIORITY`.	BALANCE
scaling_policy	string	No	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 to local disks.	release
on_demand_base_capacity	long	No	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 smaller than the value of this parameter, Auto Scaling preferably creates pay-as-you-go instances.	0
on_demand_percentage_above_base_capacity	long	No	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_pools	long	No	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_remedy	boolean	No	Specifies whether to supplement preemptible instances. If you set this parameter to true, when the scaling group receives a system message indicating that a preemptible instance is to be reclaimed, the scaling group creates a new instance to replace this instance. Valid values: `true`: supplements preemptible instances. `false`: does not supplement preemptible instances.	false
compensate_with_on_demand	boolean	No	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 cost or insufficient inventory. This parameter takes effect only 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
rds_instances	array	No	A list of ApsaraDB RDS instances.
	string	No	The ID of the ApsaraDB RDS instance. After you specify the list of ApsaraDB RDS instances, the ECS instances in the cluster are automatically added to the whitelist of the ApsaraDB RDS instances.	rds-xxx
private_pool_options	object	No	The configurations of the private node pool.
id	string	No	The private node pool ID.	eap-bp67acfmxazb4****
match_criteria	string	No	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 pool is generated when an elasticity assurance or a capacity reservation takes effect. The system selects a private pool to start instances. Valid values: `Open`: open private node pool. The system selects an open private pool to start instances. If no matching open private pools are available, the resources in the public pool are used. `Target`: private node pool. The system uses the resources of the specified private pool to start instances. If the specified private pool is unavailable, instances cannot be started. `None`: does not use private pools. The resources of private node pools are not used to launch instances.	Open
platform`deprecated`	string	No	The OS platform. Valid values: `AliyunLinux` `CentOS` `Windows` `WindowsCore`	AliyunLinux
kubernetes_config	object	No	The configurations of the cluster in which the node pool is deployed.
labels	array	No	The labels that you want to add to nodes in the cluster. You must add labels based on the following rules: A label is a case-sensitive key-value pair. You can add up to 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.
	tag	No	The label.
taints	array	No	The taints.
	taint	No	The taint.
runtime	string	No	The name of the container runtime.	docker
runtime_version	string	No	The version of the container runtime.	19.03.5
cpu_policy	string	No	The CPU management policy of 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 with enhanced CPU affinity and exclusivity. `none`: specifies that the default CPU affinity is used. Default value: `none`.	none
unschedulable	boolean	No	Specifies whether the nodes are unschedulable after a scale-out activity is performed.	false
user_data	string	No	The user data on the node. For more information, see Prepare user data.	IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi
cms_enabled	boolean	No	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
tee_config	object	No	The configurations about confidential computing for the cluster.
tee_enable	boolean	No	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
update_nodes	boolean	No	Specifies whether to update node information, such as labels and taints.	true
concurrency	boolean	No	Specifies whether concurrency is supported.	true

Response parameters

Parameter	Type	Description	Example
	object	The response body.
task_id	string	The task ID.	T-5fd211e924e1d00787000293
nodepool_id	string	The node pool ID.	np737c3ac1ac684703b9e10673aa2c****
request_id	string	The ID of the request.	687C5BAA-D103-4993-884B-C35E4314****

Examples

Sample success responses

JSONformat

{
  "task_id": "T-5fd211e924e1d00787000293",
  "nodepool_id": "np737c3ac1ac684703b9e10673aa2c****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-06-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-04-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-01-19	The response structure of the API has changed	View Change Details
2023-12-15	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-10-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-08-30	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-08-10	The internal configuration of the API is changed, but the call is not affected	View Change Details
2020-09-23	The internal configuration of the API is changed, but the call is not affected	View Change Details