Nodepool API reference - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Parameter	Type	Description	Example
	object	The node pool.
auto_scaling	object	The auto scaling node pool configuration.
eip_bandwidth	integer	[Deprecated] The peak bandwidth of the elastic IP address (EIP). Unit: Mbit/s.	5
eip_internet_charge_type	string	[Deprecated] The billing method of the EIP. Valid values: `PayByBandwidth`: pay-by-bandwidth `PayByTraffic`: pay-by-data-transfer Default value: `PayByBandwidth`.	PayByBandwidth
enable	boolean	Specifies whether to enable auto scaling. Valid values: `true`: enables auto scaling for the node pool. `false`: disables auto scaling. If this parameter is set to false, other configuration parameters in auto_scaling do not take effect. Default value: `false`.	true
is_bond_eip	boolean	[Deprecated] Specifies whether to associate an EIP. Valid values: `true`: associates an EIP. `false`: does not associate an EIP. Default value: `false`.	true
max_instances	integer	The maximum number of instances in the auto scaling group.	10
min_instances	integer	The minimum number of instances in the auto scaling group.	0
type	string	The auto scaling type, which is classified by the instance type used for auto scaling. Valid values: `cpu`: regular instance `gpu`: GPU-accelerated instance `gpushare`: shared GPU instance `spot`: spot instance Default value: `cpu`.	cpu
count	integer	[Deprecated] Use desired_size instead. The number of nodes in the node pool.	1
interconnect_config	object	[Deprecated] The configuration of the edge node pool.
bandwidth	integer	[Deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbit/s.	10
ccn_id	string	[Deprecated] The instance ID of the Cloud Connect Network (CCN) attached to the enhanced edge node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[Deprecated] The region of the CCN instance associated with the enhanced edge node pool.	cn-shanghai
cen_id	string	[Deprecated] The instance ID of the Cloud Enterprise Network (CEN) attached to the enhanced edge node pool.	cen-ey9k9nfhz0f*******
improved_period	string	[Deprecated] The subscription duration of the enhanced edge node pool. Unit: months.	1
interconnect_mode	string	The network type of the edge node pool. This parameter is valid only when type is set to edge. Valid values: `basic`: basic `private`: dedicated. Supported in Kubernetes 1.22 and later.	basic
kubernetes_config	object	The cluster-related configurations.
cms_enabled	boolean	Specifies whether to install CloudMonitor on ECS nodes. After installation, you can view the monitoring information of the created ECS instances in the CloudMonitor console. Enabling this feature is recommended. Valid values: `true`: installs CloudMonitor on ECS nodes. `false`: does not install CloudMonitor on ECS nodes. Default value: `false`.	true
cpu_policy	string	The CPU management policy for nodes. The following two policies are supported when the cluster version is 1.12.6 or later: `static`: allows you to enhance CPU affinity and exclusivity for pods with specific resource characteristics on the node. `none`: uses the existing default CPU affinity scheme. Default value: `none`.	none
labels	array	The node labels, which are added to the nodes in the Kubernetes cluster.
	tag	The node label.
node_name_mode	string	The custom node name consists of three parts: prefix + node IP address + suffix. The prefix and suffix can each consist of one or more parts separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or a digit. The node IP address is the complete private IP address of the node. The parameter value contains four parts separated by commas. For example, if the parameter is set to "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is aliyun.192.168.xxx.xxx.com.	customized,aliyun,ip,com
runtime	string	The container runtime. Valid values: `containerd`: recommended. Supported by all cluster versions. `Sandboxed-Container.runv`: sandboxed container. Provides higher isolation. Supported in Kubernetes 1.24 and earlier. `docker`: supported in Kubernetes 1.22 and earlier. Default value: `containerd`.	containerd
runtime_version	string	The container runtime version.	1.6.20
taints	array	The taint configurations.
	taint	The taint configurations.
user_data	string	The user data of the node.	MXM=
management	object	The managed node pool configuration.
auto_fault_diagnosis	boolean	Specifies whether to enable ECS fault detection for node auto healing.
auto_repair	boolean	Specifies whether to enable auto repair. This parameter takes effect only when enable is set to true. Valid values: `true`: enables auto repair. `false`: disables auto repair.	false
auto_repair_policy	object	The auto repair policy for nodes.
max_parallel_repairing_nodes	string	The maximum number of parallel repairs. When a large number of abnormal nodes exist in the node pool, this parameter specifies the maximum number or percentage of nodes that can be repaired simultaneously. You can specify a number (such as 5, valid values: 1 to 100000) or a percentage (such as 10%, valid values: 1% to 100%). Default value: 1.	5
max_unhealthy_nodes_threshold	string	The circuit breaker threshold for auto healing. When the number or percentage of faulty nodes exceeds this threshold, auto healing enters the circuit breaker state and stops initiating new auto healing actions. You can specify a number (such as 10, valid values: 1 to 100000) or a percentage (such as 20%, valid values: 1% to 100%). Default value: 100%.	20%
restart_node	boolean	Specifies whether to allow node restarts.	true
auto_upgrade	boolean	Specifies whether to enable auto upgrade.	true
auto_upgrade_policy	object	The auto upgrade policy.
auto_upgrade_kubelet	boolean	Specifies whether to allow automatic upgrades of kubelet.	true
auto_vul_fix	boolean	Specifies whether to automatically fix Common Vulnerabilities and Exposures (CVEs).	true
auto_vul_fix_policy	object	The policy for automatically fixing CVEs.
restart_node	boolean	Specifies whether to allow node restarts.	true
vul_level	string	The vulnerability levels that are allowed to be automatically fixed, separated by commas.	asap,nntf
drift_enabled	boolean	Specifies whether to enable node drift remediation. This feature is supported only by smart managed node pools and is enabled by default. Regular node pools do not support this feature.
enable	boolean	Specifies whether to enable the managed node pool. Valid values: `true`: enables the managed node pool. `false`: does not enable the managed node pool. Other related configurations take effect only when `enable` is set to `true`.	false
upgrade_config	object	The auto upgrade configuration. This configuration takes effect only when `enable` is set to `true`.
auto_upgrade	boolean	Specifies whether to enable auto upgrade. Valid values: `true`: enables auto upgrade. `false`: disables auto upgrade.	false
max_unavailable	integer	The maximum number of unavailable nodes. Valid values: 1 to 1000. Default value: 1.	0
surge	integer	The number of additional nodes.	0
surge_percentage	integer	The percentage of additional nodes. This parameter and `surge` are mutually exclusive.	0
max_nodes	integer	The maximum number of nodes that the edge node pool can accommodate. The value must be greater than or equal to 0. A value of 0 indicates no additional limit, and the number of nodes is limited only by the maximum number of nodes that the cluster can accommodate. This value is usually greater than 0 for edge node pools. For ess node pools and default edge node pools, this value is 0.	10
node_components	array	The list of node components.
	object	The node component.
config	object	The configuration of the node component.
custom_config	object	The custom configuration of the node component.	{"cpuManagerPolicy":"static"}
	any	The custom configuration string of the node component.	cpuManagerPolicy
envs	array	The environment variables of the node component.
	object
name	string	The name of the environment variable.	LOG_LEVEL
value	string	The value of the environment variable.	info
name	string	The name of the node component.	kubelet
version	string	The version of the node component.	1.33.3-aliyun.1
node_config	object	The node configuration.
kubelet_configuration	kubelet_config	The Kubelet parameter settings.
nodepool_info	object	The node pool configuration.
name	string	The name of the node pool.	np-test
resource_group_id	string	The ID of the resource group to which the node pool belongs.	rg-acfmyvw3wjm****
type	string	The type of the node pool. Valid values: `ess`: node pool. `edge`: edge node pool.	ess
scaling_group	object	The scaling group configuration of the node pool.
auto_renew	boolean	Specifies whether to enable auto-renewal for the nodes in the node pool. This parameter takes effect only when `instance_charge_type` is set to `PrePaid`. Valid values: `true`: enables auto-renewal. `false`: disables auto-renewal. Default value: `true`.	false
auto_renew_period	integer	The auto-renewal epoch for the nodes in the node pool. This parameter takes effect and is required only when `instance_charge_type` is set to `PrePaid`. If `PeriodUnit` is set to `Month`, valid values are 1, 2, 3, 6, and 12. Default value: 1.	0
compensate_with_on_demand	boolean	Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if the system cannot create enough spot instances due to price or inventory issues when `multi_az_policy` is set to `COST_OPTIMIZED`. Valid values: `true`: automatically creates pay-as-you-go instances to meet the required number of ECS instances. `false`: does not automatically create pay-as-you-go instances.	true
cpu_options	object	The CPU-related configuration options.
nested_virtualization	string	Specifies whether to enable nested virtualization. Valid values: disabled: disables nested virtualization. enabled: enables nested virtualization.	enabled
data_disks	array	The data cloud disk configuration for the nodes in the node pool.
	data_disk	The data cloud disk configuration for the nodes in the node pool.
deploymentset_id	string	The ID of the deployment set.	ds-bp1d19mmbsv3jf6xxxxx
desired_size	integer	The desired number of nodes in the node pool.	2
disk_init	array	The block device initialization configuration.
	DiskInit	The DiskInit configuration.
image_id	string	The ID of the custom image. By default, the system image is used.	aliyun_2_1903_x64_20G_alibase_20200904.vhd
image_type	string	The type of the operating system image. This parameter and `platform` are mutually exclusive. Valid values: `AliyunLinux`: Alinux2 image. `AliyunLinux3`: Alinux3 image. `AliyunLinux3Arm64`: Alinux3 ARM image. `AliyunLinuxUEFI`: Alinux2 UEFI image. `CentOS`: CentOS image. `Windows`: Windows image. `WindowsCore`: Windows Core image. `ContainerOS`: container-optimized image.	AliyunLinux
instance_charge_type	string	The billing method of the nodes in the node pool. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go. Default value: `PostPaid`.	PostPaid
instance_metadata_options	InstanceMetadataOptions	The metadata access configuration for ECS instances. This parameter is available only to whitelisted accounts. To use this parameter, submit a ticket.
instance_patterns	array	The instance properties.
	instance_patterns	The individual instance property.
instance_types	array	The instance types.
	string	The instance types.	ecs.n1.medium
internet_charge_type	string	The billing method for the public IP address. Valid values: `PayByBandwidth`: Pay-by-bandwidth. `PayByTraffic`: Pay-by-traffic.	PayByBandwidth
internet_max_bandwidth_out	integer	The maximum outbound bandwidth for the public IP address of a node. Unit: Mbit/s. Valid values: 1 to 100.	10
key_pair	string	The name of the key pair. You must specify this parameter or `login_password`. Note If you create a managed node pool, only `key_pair` is supported.	np-key
login_as_non_root	boolean	Specifies whether to log on to the created ECS instances as a non-root user.
login_password	string	The SSH logon password. You must specify this parameter or `key_pair`. 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
multi_az_policy	string	The scaling policy for ECS instances in a multi-zone scaling group. Valid values: `PRIORITY`: scales ECS instances based on the priority of the vSwitches that you specify in VSwitchIds.N. If ECS instances cannot be created in the zone of the highest-priority vSwitch, the system automatically uses the next highest-priority vSwitch to create ECS instances. `COST_OPTIMIZED`: creates ECS instances based on the unit price of vCPUs in ascending order. When the scaling configuration specifies multiple instance types and the billing method is set to spot instance, the system preferentially creates spot instances. You can use the `CompensateWithOnDemand` parameter to specify whether to automatically create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory or other reasons. Note `COST_OPTIMIZED` takes effect only when the scaling configuration specifies multiple instance types or spot instances. `BALANCE`: evenly allocates ECS instances across the zones specified in the scaling group. If the distribution of instances becomes unbalanced across zones due to insufficient inventory or other reasons, you can call the RebalanceInstances operation to balance the resources. For more information, see RebalanceInstances. Default value: `PRIORITY`.	COST_OPTIMIZED
on_demand_base_capacity	integer	The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than this value, the system preferentially creates pay-as-you-go instances.	0
on_demand_percentage_above_base_capacity	integer	The percentage of pay-as-you-go instances among the instances that exceed the minimum number of pay-as-you-go instances specified by `on_demand_base_capacity`. Valid values: 0 to 100.	20
period	integer	The subscription duration of nodes in the node pool. This parameter takes effect and is required only when `instance_charge_type` is set to `PrePaid`. When `period_unit` is set to Month, valid values of `period` are 1, 2, 3, 6, and 12. Default value: 1.	0
period_unit	string	The billing cycle of nodes in the node pool. This parameter is required when `instance_charge_type` is set to `PrePaid`. `Month`: Currently, only months are supported.	Month
platform	string	The operating system distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore` Default value: `AliyunLinux`.	AliyunLinux
private_pool_options	object	The private pool options.
id	string	The ID of the private pool.	eap-bp67acfmxazb4****
match_criteria	string	The match criteria of the private pool. This parameter specifies the private pool capacity option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for you to select when you start instances. Valid values: `Open`: open mode. The system automatically matches an open private pool. If no eligible private pool is available, the system uses the public pool. `Target`: specified mode. The system uses the specified private pool to start instances. If the specified private pool is unavailable, the instances fail to start. `None`: no private pool. The system does not use private pools to start instances.	Open
ram_role_name	string	The name of the RAM role for worker nodes. Important Only ACK managed clusters of version 1.22 and later support this parameter when you create a node pool.	example-role
rds_instances	array	The list of ApsaraDB RDS instances.
	string	The RDS instance ID.	rm-2zey3t89t6280****
resource_pool_options	object	The resource pool and resource pool policy used to create instances. Take note of the following items when you configure this parameter: This parameter takes effect only when you create pay-as-you-go instances. This parameter cannot be configured together with private_pool_options.match_criteria or private_pool_options.id.
private_pool_ids	array	The list of private pool IDs, which are the IDs of elasticity assurances or capacity reservations. You can only specify the IDs of private pools in Target mode. Valid values of N: 1 to 20.
	string	The ID of the private pool, which is the ID of an elasticity assurance or capacity reservation. You can only specify the ID of a private pool in Target mode.	eap-bp67acfmxazb4****
strategy	string	The resource pool policy used to create instances. Resource pools include private pools generated after elasticity assurances or capacity reservations take effect, as well as the public pool. Valid values: PrivatePoolFirst: Private pool first. If you select this policy and specify resource_pool_options.private_pool_ids, the specified private pools are preferentially used. If no private pool is specified or the specified private pools have insufficient capacity, the system automatically matches an open private pool. If no eligible private pool is available, the system uses the public pool to create instances. PrivatePoolOnly: Private pool only. If you select this policy, you must specify resource_pool_options.private_pool_ids. If the specified private pools have insufficient capacity, the instances fail to start. None: No resource pool policy. Default value: None.	PrivatePoolFirst
scaling_policy	string	The scaling pattern of the scaling group. Valid values: `release`: standard pattern. The scaling group scales instances by creating and releasing ECS instances based on the usage of requested resources. `recycle`: swift pattern. The scaling group scales instances by creating, stopping, and starting ECS instances to accelerate subsequent scaling operations. When an instance is stopped, you are not charged for compute resources, but you are still charged for storage resources, except for instances with local disks. Default value: `release`.	release
security_group_id	string	The ID of the security group to which the node pool belongs. You must specify this parameter or `security_group_ids`. We recommend that you specify `security_group_ids`.	sg-2zeihch86ooz9io4****
security_group_ids	array	The list of security group IDs. You must specify this parameter or `security_group_id`. We recommend that you specify `security_group_ids`. If you specify both `security_group_id` and `security_group_ids`, `security_group_ids` takes precedence.
	string	The ID of the security group.	sg-2zeihch86ooz9io4****
spot_instance_pools	integer	The number of available instance types. The scaling group evenly creates spot instances based on the most cost-effective instance types. Valid values: 1 to 10.	5
spot_instance_remedy	boolean	Specifies whether to enable spot instance replenishment. After this feature is enabled, when the scaling group receives a system message indicating that a spot instance will be reclaimed, the scaling group attempts to create a new instance to replace the spot instance to be reclaimed. Valid values: `true`: enables spot instance replenishment. `false`: disables spot instance replenishment.	false
spot_price_limit	array	The maximum price configuration for a single spot instance of a specific instance type.
	object
instance_type	string	The instance type of the spot instance.	ecs.c6.large
price_limit	string	The maximum price for a single instance.	0.39
spot_strategy	string	The type of spot instance. Valid values: NoSpot: non-spot instance. SpotWithPriceLimit: spot instance with a maximum price. SpotAsPriceGo: spot instance whose price is automatically set based on the market price. For more information, see Spot instances.	NoSpot
system_disk_bursting_enabled	boolean	Specifies whether to enable the performance burst feature for the system disk of a node. Valid values: true: yes. false: no. This parameter is supported only when `SystemDiskCategory` is set to `cloud_auto`. For more information, see ESSD AutoPL cloud disks.	true
system_disk_categories	array	The categories of the system disk. If the system disk cannot be created by using the disk category with the highest priority, the system automatically tries the next disk category. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.
	string	The category of the system disk.	cloud_essd
system_disk_category	string	The category of the system disk. Valid values: `cloud_efficiency`: ultra disk. `cloud_ssd`: standard SSD. `cloud_essd`: ESSD. `cloud_auto`: ESSD AutoPL disk. `cloud_essd_entry`: ESSD Entry disk. Default value: `cloud_efficiency`.	cloud_efficiency
system_disk_encrypt_algorithm	string	The encryption algorithm used for the system disk. Valid value: aes-256.	aes-256
system_disk_encrypted	boolean	Specifies whether to encrypt the system disk. Valid values: true: encrypts the system disk. false: does not encrypt the system disk.
system_disk_kms_key_id	string	The ID of the KMS key used for the system disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_performance_level	string	The performance level of the system disk. This parameter takes effect only for ESSDs. Valid values: PL0: provides medium concurrent I/O performance and relatively stable read/write latency. PL1: provides medium concurrent I/O performance and relatively stable read/write latency. PL2: provides high concurrent I/O performance and stable read/write latency. PL3: provides ultra-high concurrent I/O performance and highly stable read/write latency.	PL1
system_disk_provisioned_iops	integer	The provisioned read and write IOPS of the system cloud disk for nodes. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}. Baseline performance = min{1,800 + 50 × capacity, 50,000}. This parameter is supported only when `SystemDiskCategory` is set to `cloud_auto`. For more information, see ESSD AutoPL cloud disks.	1000
system_disk_size	integer	The size of the system cloud disk for nodes. Unit: GiB. Valid values: 40 to 500.	120
tags	array	The tags added only to ECS instances. Tag keys must be unique and can be up to 128 characters in length. Tag keys and tag values cannot start with "aliyun" or "acs:", or contain "https://" or "http://".
	object
key	string	The tag key.	key
value	string	The tag value.	value
vswitch_ids	array	The vSwitch IDs.
	string	The vSwitch IDs.	vsw-2ze0fmpbwo140ahni****
tee_config	object	The confidential computing node pool configuration.
tee_enable	boolean	Specifies whether the node pool is a confidential computing node pool.	false

object

The node pool.

auto_scaling

object

The auto scaling node pool configuration.

eip_bandwidth

integer

[Deprecated] The peak bandwidth of the elastic IP address (EIP). Unit: Mbit/s.

5

eip_internet_charge_type

string

[Deprecated] The billing method of the EIP. Valid values:

PayByBandwidth: pay-by-bandwidth
PayByTraffic: pay-by-data-transfer Default value: PayByBandwidth.

PayByBandwidth

enable

boolean

Specifies whether to enable auto scaling. Valid values:

true: enables auto scaling for the node pool.
false: disables auto scaling. If this parameter is set to false, other configuration parameters in auto_scaling do not take effect. Default value: false.

true

is_bond_eip

boolean

[Deprecated] Specifies whether to associate an EIP. Valid values:

true: associates an EIP.
false: does not associate an EIP. Default value: false.

true

max_instances

integer

The maximum number of instances in the auto scaling group.

10

min_instances

integer

The minimum number of instances in the auto scaling group.

0

type

string

The auto scaling type, which is classified by the instance type used for auto scaling. Valid values:

cpu: regular instance
gpu: GPU-accelerated instance
gpushare: shared GPU instance
spot: spot instance Default value: cpu.

cpu

count

integer

[Deprecated] Use desired_size instead. The number of nodes in the node pool.

1

interconnect_config

object

[Deprecated] The configuration of the edge node pool.

bandwidth

integer

[Deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbit/s.

10

ccn_id

string

[Deprecated] The instance ID of the Cloud Connect Network (CCN) attached to the enhanced edge node pool.

ccn-qm5i0i0q9yi*******

ccn_region_id

string

[Deprecated] The region of the CCN instance associated with the enhanced edge node pool.

cn-shanghai

cen_id

string

[Deprecated] The instance ID of the Cloud Enterprise Network (CEN) attached to the enhanced edge node pool.

cen-ey9k9nfhz0f*******

improved_period

string

[Deprecated] The subscription duration of the enhanced edge node pool. Unit: months.

1

interconnect_mode

string

The network type of the edge node pool. This parameter is valid only when type is set to edge. Valid values:

basic: basic
private: dedicated. Supported in Kubernetes 1.22 and later.

basic

kubernetes_config

object

The cluster-related configurations.

cms_enabled

boolean

Specifies whether to install CloudMonitor on ECS nodes. After installation, you can view the monitoring information of the created ECS instances in the CloudMonitor console. Enabling this feature is recommended. Valid values:

true: installs CloudMonitor on ECS nodes.
false: does not install CloudMonitor on ECS nodes. Default value: false.

true

cpu_policy

string

The CPU management policy for nodes. The following two policies are supported when the cluster version is 1.12.6 or later:

static: allows you to enhance CPU affinity and exclusivity for pods with specific resource characteristics on the node.
none: uses the existing default CPU affinity scheme. Default value: none.

none

labels

array

The node labels, which are added to the nodes in the Kubernetes cluster.

tag

The node label.

node_name_mode

string

The custom node name consists of three parts: prefix + node IP address + suffix.

The prefix and suffix can each consist of one or more parts separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or a digit.
The node IP address is the complete private IP address of the node. The parameter value contains four parts separated by commas. For example, if the parameter is set to "customized,aliyun,ip,com" (where "customized" and "ip" are fixed strings, "aliyun" is the prefix, and "com" is the suffix), the node name is aliyun.192.168.xxx.xxx.com.

customized,aliyun,ip,com

runtime

string

The container runtime. Valid values:

containerd: recommended. Supported by all cluster versions.
Sandboxed-Container.runv: sandboxed container. Provides higher isolation. Supported in Kubernetes 1.24 and earlier.
docker: supported in Kubernetes 1.22 and earlier. Default value: containerd.

containerd

runtime_version

string

The container runtime version.

1.6.20

taints

array

The taint configurations.

taint

The taint configurations.

user_data

string

The user data of the node.

MXM=

management

object

The managed node pool configuration.

auto_fault_diagnosis

boolean

Specifies whether to enable ECS fault detection for node auto healing.

auto_repair

boolean

Specifies whether to enable auto repair. This parameter takes effect only when enable is set to true. Valid values:

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

false

auto_repair_policy

object

The auto repair policy for nodes.

max_parallel_repairing_nodes

string

The maximum number of parallel repairs. When a large number of abnormal nodes exist in the node pool, this parameter specifies the maximum number or percentage of nodes that can be repaired simultaneously. You can specify a number (such as 5, valid values: 1 to 100000) or a percentage (such as 10%, valid values: 1% to 100%). Default value: 1.

5

max_unhealthy_nodes_threshold

string

The circuit breaker threshold for auto healing. When the number or percentage of faulty nodes exceeds this threshold, auto healing enters the circuit breaker state and stops initiating new auto healing actions. You can specify a number (such as 10, valid values: 1 to 100000) or a percentage (such as 20%, valid values: 1% to 100%). Default value: 100%.

20%

restart_node

boolean

Specifies whether to allow node restarts.

true

auto_upgrade

boolean

Specifies whether to enable auto upgrade.

true

auto_upgrade_policy

object

The auto upgrade policy.

auto_upgrade_kubelet

boolean

Specifies whether to allow automatic upgrades of kubelet.

true

auto_vul_fix

boolean

Specifies whether to automatically fix Common Vulnerabilities and Exposures (CVEs).

true

auto_vul_fix_policy

object

The policy for automatically fixing CVEs.

restart_node

boolean

Specifies whether to allow node restarts.

true

vul_level

string

The vulnerability levels that are allowed to be automatically fixed, separated by commas.

asap,nntf

drift_enabled

boolean

Specifies whether to enable node drift remediation. This feature is supported only by smart managed node pools and is enabled by default. Regular node pools do not support this feature.

enable

boolean

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

true: enables the managed node pool.
false: does not enable the managed node pool. Other related configurations take effect only when enable is set to true.

false

upgrade_config

object

The auto upgrade configuration. This configuration takes effect only when enable is set to true.

auto_upgrade

boolean

Specifies whether to enable auto upgrade. Valid values:

true: enables auto upgrade.
false: disables auto upgrade.

false

max_unavailable

integer

The maximum number of unavailable nodes. Valid values: 1 to 1000.

Default value: 1.

0

surge

integer

The number of additional nodes.

0

surge_percentage

integer

The percentage of additional nodes. This parameter and surge are mutually exclusive.

0

max_nodes

integer

The maximum number of nodes that the edge node pool can accommodate. The value must be greater than or equal to 0. A value of 0 indicates no additional limit, and the number of nodes is limited only by the maximum number of nodes that the cluster can accommodate. This value is usually greater than 0 for edge node pools. For ess node pools and default edge node pools, this value is 0.

10

node_components

array

The list of node components.

object

The node component.

config

object

The configuration of the node component.

custom_config

object

The custom configuration of the node component.

{"cpuManagerPolicy":"static"}

any

The custom configuration string of the node component.

cpuManagerPolicy

envs

array

The environment variables of the node component.

object

name

string

The name of the environment variable.

LOG_LEVEL

value

string

The value of the environment variable.

info

name

string

The name of the node component.

kubelet

version

string

The version of the node component.

1.33.3-aliyun.1

node_config

object

The node configuration.

kubelet_configuration

kubelet_config

The Kubelet parameter settings.

nodepool_info

object

The node pool configuration.

name

string

The name of the node pool.

np-test

resource_group_id

string

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

rg-acfmyvw3wjm****

type

string

The type of the node pool. Valid values:

ess: node pool.
edge: edge node pool.

ess

scaling_group

object

The scaling group configuration of the node pool.

auto_renew

boolean

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

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

Default value: true.

false

auto_renew_period

integer

The auto-renewal epoch for the nodes in the node pool. This parameter takes effect and is required only when instance_charge_type is set to PrePaid.

If PeriodUnit is set to Month, valid values are 1, 2, 3, 6, and 12.

Default value: 1.

0

compensate_with_on_demand

boolean

Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if the system cannot create enough spot instances due to price or inventory issues when multi_az_policy is set to COST_OPTIMIZED. Valid values:

true: automatically creates pay-as-you-go instances to meet the required number of ECS instances.
false: does not automatically create pay-as-you-go instances.

true

cpu_options

object

The CPU-related configuration options.

nested_virtualization

string

Specifies whether to enable nested virtualization. Valid values:

disabled: disables nested virtualization.
enabled: enables nested virtualization.

enabled

data_disks

array

The data cloud disk configuration for the nodes in the node pool.

data_disk

The data cloud disk configuration for the nodes in the node pool.

deploymentset_id

string

The ID of the deployment set.

ds-bp1d19mmbsv3jf6xxxxx

desired_size

integer

The desired number of nodes in the node pool.

2

disk_init

array

The block device initialization configuration.

DiskInit

The DiskInit configuration.

image_id

string

The ID of the custom image. By default, the system image is used.

aliyun_2_1903_x64_20G_alibase_20200904.vhd

image_type

string

The type of the operating system image. This parameter and platform are mutually exclusive. Valid values:

AliyunLinux: Alinux2 image.
AliyunLinux3: Alinux3 image.
AliyunLinux3Arm64: Alinux3 ARM image.
AliyunLinuxUEFI: Alinux2 UEFI image.
CentOS: CentOS image.
Windows: Windows image.
WindowsCore: Windows Core image.
ContainerOS: container-optimized image.

AliyunLinux

instance_charge_type

string

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

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

Default value: PostPaid.

PostPaid

instance_metadata_options

InstanceMetadataOptions

The metadata access configuration for ECS instances. This parameter is available only to whitelisted accounts. To use this parameter, submit a ticket.

instance_patterns

array

The instance properties.

instance_patterns

The individual instance property.

instance_types

array

The instance types.

string

The instance types.

ecs.n1.medium

internet_charge_type

string

The billing method for the public IP address. Valid values:

PayByBandwidth: Pay-by-bandwidth.
PayByTraffic: Pay-by-traffic.

PayByBandwidth

internet_max_bandwidth_out

integer

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

10

key_pair

string

The name of the key pair. You must specify this parameter or login_password.

Note

If you create a managed node pool, only key_pair is supported.

np-key

The SSH logon password. You must specify this parameter or key_pair. 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.

multi_az_policy

string

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

PRIORITY: scales ECS instances based on the priority of the vSwitches that you specify in VSwitchIds.N. If ECS instances cannot be created in the zone of the highest-priority vSwitch, the system automatically uses the next highest-priority vSwitch to create ECS instances.
COST_OPTIMIZED: creates ECS instances based on the unit price of vCPUs in ascending order. When the scaling configuration specifies multiple instance types and the billing method is set to spot instance, the system preferentially creates spot instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory or other reasons.

Note
COST_OPTIMIZED takes effect only when the scaling configuration specifies multiple instance types or spot instances.
BALANCE: evenly allocates ECS instances across the zones specified in the scaling group. If the distribution of instances becomes unbalanced across zones due to insufficient inventory or other reasons, you can call the RebalanceInstances operation to balance the resources. For more information, see RebalanceInstances.

Default value: PRIORITY.

COST_OPTIMIZED

on_demand_base_capacity

integer

The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than this value, the system preferentially creates pay-as-you-go instances.

0

on_demand_percentage_above_base_capacity

integer

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

20

period

integer

The subscription duration of nodes in the node pool. This parameter takes effect and is required only when instance_charge_type is set to PrePaid. When period_unit is set to Month, valid values of period are 1, 2, 3, 6, and 12.

Default value: 1.

0

period_unit

string

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

Month: Currently, only months are supported.

Month

platform

string

The operating system distribution. Valid values:

CentOS
AliyunLinux
Windows
WindowsCore

Default value: AliyunLinux.

AliyunLinux

private_pool_options

object

The private pool options.

id

string

The ID of the private pool.

eap-bp67acfmxazb4****

match_criteria

string

The match criteria of the private pool. This parameter specifies the private pool capacity option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for you to select when you start instances. Valid values:

Open: open mode. The system automatically matches an open private pool. If no eligible private pool is available, the system uses the public pool.
Target: specified mode. The system uses the specified private pool to start instances. If the specified private pool is unavailable, the instances fail to start.
None: no private pool. The system does not use private pools to start instances.

Open

ram_role_name

string

The name of the RAM role for worker nodes.

Important Only ACK managed clusters of version 1.22 and later support this parameter when you create a node pool.

example-role

rds_instances

array

The list of ApsaraDB RDS instances.

string

The RDS instance ID.

rm-2zey3t89t6280****

resource_pool_options

object

The resource pool and resource pool policy used to create instances. Take note of the following items when you configure this parameter: This parameter takes effect only when you create pay-as-you-go instances. This parameter cannot be configured together with private_pool_options.match_criteria or private_pool_options.id.

private_pool_ids

array

The list of private pool IDs, which are the IDs of elasticity assurances or capacity reservations. You can only specify the IDs of private pools in Target mode. Valid values of N: 1 to 20.

string

The ID of the private pool, which is the ID of an elasticity assurance or capacity reservation. You can only specify the ID of a private pool in Target mode.

eap-bp67acfmxazb4****

strategy

string

The resource pool policy used to create instances. Resource pools include private pools generated after elasticity assurances or capacity reservations take effect, as well as the public pool. Valid values: PrivatePoolFirst: Private pool first. If you select this policy and specify resource_pool_options.private_pool_ids, the specified private pools are preferentially used. If no private pool is specified or the specified private pools have insufficient capacity, the system automatically matches an open private pool. If no eligible private pool is available, the system uses the public pool to create instances. PrivatePoolOnly: Private pool only. If you select this policy, you must specify resource_pool_options.private_pool_ids. If the specified private pools have insufficient capacity, the instances fail to start. None: No resource pool policy. Default value: None.

PrivatePoolFirst

scaling_policy

string

The scaling pattern of the scaling group. Valid values:

release: standard pattern. The scaling group scales instances by creating and releasing ECS instances based on the usage of requested resources.
recycle: swift pattern. The scaling group scales instances by creating, stopping, and starting ECS instances to accelerate subsequent scaling operations. When an instance is stopped, you are not charged for compute resources, but you are still charged for storage resources, except for instances with local disks.

Default value: release.

release

security_group_id

string

The ID of the security group to which the node pool belongs. You must specify this parameter or security_group_ids. We recommend that you specify security_group_ids.

sg-2zeihch86ooz9io4****

security_group_ids

array

The list of security group IDs. You must specify this parameter or security_group_id. We recommend that you specify security_group_ids. If you specify both security_group_id and security_group_ids, security_group_ids takes precedence.

string

The ID of the security group.

sg-2zeihch86ooz9io4****

spot_instance_pools

integer

The number of available instance types. The scaling group evenly creates spot instances based on the most cost-effective instance types. Valid values: 1 to 10.

5

spot_instance_remedy

boolean

Specifies whether to enable spot instance replenishment. After this feature is enabled, when the scaling group receives a system message indicating that a spot instance will be reclaimed, the scaling group attempts to create a new instance to replace the spot instance to be reclaimed. Valid values:

true: enables spot instance replenishment.
false: disables spot instance replenishment.

false

spot_price_limit

array

The maximum price configuration for a single spot instance of a specific instance type.

object

instance_type

string

The instance type of the spot instance.

ecs.c6.large

price_limit

string

The maximum price for a single instance.

0.39

spot_strategy

string

The type of spot instance. Valid values:

NoSpot: non-spot instance.
SpotWithPriceLimit: spot instance with a maximum price.
SpotAsPriceGo: spot instance whose price is automatically set based on the market price.

For more information, see Spot instances.

NoSpot

system_disk_bursting_enabled

boolean

Specifies whether to enable the performance burst feature for the system disk of a node. Valid values:

true: yes.
false: no.

This parameter is supported only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.

true

system_disk_categories

array

The categories of the system disk. If the system disk cannot be created by using the disk category with the highest priority, the system automatically tries the next disk category. Valid values:

cloud: basic disk.
cloud_efficiency: ultra disk.
cloud_ssd: standard SSD.
cloud_essd: ESSD.

string

The category of the system disk.

cloud_essd

system_disk_category

string

The category of the system disk. Valid values:

cloud_efficiency: ultra disk.
cloud_ssd: standard SSD.
cloud_essd: ESSD.
cloud_auto: ESSD AutoPL disk.
cloud_essd_entry: ESSD Entry disk.

Default value: cloud_efficiency.

cloud_efficiency

system_disk_encrypt_algorithm

string

The encryption algorithm used for the system disk. Valid value: aes-256.

aes-256

system_disk_encrypted

boolean

Specifies whether to encrypt the system disk. Valid values:

true: encrypts the system disk.
false: does not encrypt the system disk.

system_disk_kms_key_id

string

The ID of the KMS key used for the system disk.

0e478b7a-4262-4802-b8cb-00d3fb40****

system_disk_performance_level

string

The performance level of the system disk. This parameter takes effect only for ESSDs. Valid values:

PL0: provides medium concurrent I/O performance and relatively stable read/write latency.
PL1: provides medium concurrent I/O performance and relatively stable read/write latency.
PL2: provides high concurrent I/O performance and stable read/write latency.
PL3: provides ultra-high concurrent I/O performance and highly stable read/write latency.

PL1

system_disk_provisioned_iops

integer

The provisioned read and write IOPS of the system cloud disk for nodes. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}. Baseline performance = min{1,800 + 50 × capacity, 50,000}. This parameter is supported only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.

1000

system_disk_size

integer

The size of the system cloud disk for nodes. Unit: GiB. Valid values: 40 to 500.

120