nodepool-阿里云帮助中心

Parameter	Type	Description	Example
	object	The node pool.
auto_scaling	object	The configurations of the auto scaling node pool.
enable	boolean	Specifies whether to enable auto scaling. `true`: Enables auto scaling for the node pool. `false`: Disables auto scaling. If you set this parameter to false, other parameters in `auto_scaling` do not take effect. Default value: `false`.	true
max_instances	integer	The maximum number of instances in the scaling group.	10
min_instances	integer	The minimum number of instances in the scaling group.	0
type	string	The type of auto scaling. This parameter is specified based on the instance type for auto scaling. Valid values: `cpu`: regular instances. `gpu`: GPU-accelerated instances. `gpushare`: shared GPU-accelerated instances. `spot`: spot instances. Default value: `cpu`.	cpu
is_bond_eip	boolean	[This parameter is deprecated] Specifies whether to associate an EIP. Valid values: `true`: Associates an EIP. `false`: Does not associate an EIP. Default value: `false`.	true
eip_internet_charge_type	string	[This parameter is deprecated] The billing method of the EIP. Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-traffic. Default value: PayByBandwidth.	PayByBandwidth
eip_bandwidth	integer	[This parameter is deprecated] The peak bandwidth of the EIP. Unit: Mbit/s.	5
kubernetes_config	object	The cluster configurations.
cms_enabled	boolean	Specifies whether to install Cloud Monitor on ECS nodes. After installation, you can view monitoring data of the created ECS instances in the Cloud Monitor console. This feature is recommended. Valid values: `true`: Installs Cloud Monitor on ECS nodes. `false`: Does not install Cloud Monitor on ECS nodes. Default value: `false`.	true
cpu_policy	string	The CPU management policy for the node. The following policies are supported for clusters of Kubernetes 1.12.6 or later: `static`: allows pods with specific resource characteristics on a node to have enhanced CPU affinity and exclusivity. `none`: enables the default CPU affinity policy. Default value: `none`.	none
labels	array	The node labels. Add labels to the nodes of the Kubernetes cluster.
	tag	The node label.
runtime	string	The container runtime. Valid values: `containerd`: This container runtime is recommended and supported by all cluster versions. `Sandboxed-Container.runv`: a sandboxed container that provides a higher level of isolation. This container runtime is supported by clusters of Kubernetes 1.24 or earlier. `docker`: This container runtime is supported by clusters of Kubernetes 1.22 or earlier. Default value: `containerd`	containerd
runtime_version	string	The container runtime version.	1.6.20
taints	array	The taint configuration.
	taint	The taint configuration.
user_data	string	The custom data of the node.	MXM=
node_name_mode	string	The node name consists of a prefix, the node IP address, and a suffix. The prefix and suffix can contain 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 consists of four parts separated by commas. For example, if you pass the string "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
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 configurations of the scaling group for the node pool.
auto_renew	boolean	Specifies whether to enable auto-renewal for 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`.	false
auto_renew_period	integer	The auto-renewal period for the node pool. This parameter is required and takes effect only when you set `instance_charge_type` to `PrePaid`. If you set PeriodUnit to Month, valid values are 1, 2, 3, 6, and 12. Default value: 1.	0
data_disks	array	The data disk configurations of the nodes in the node pool.
	data_disk	The data disk configurations of the nodes in the node pool.
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-provided image is used.	aliyun_2_1903_x64_20G_alibase_20200904.vhd
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_types	array	The instance type.
	string	The instance type.	ecs.n1.medium
key_pair	string	The name of the key pair. This parameter is mutually exclusive with `login_password`. Note If you create a managed node pool, only `key_pair` is supported.	np-key
login_password	string	The SSH logon password. This parameter is mutually exclusive with `key_pair`. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.	Hello1234
login_as_non_root	boolean	Specifies whether to log on to the scaled ECS instances as a non-root user.
period	integer	The subscription duration of the nodes in the node pool. This parameter is required and takes effect only when you set `instance_charge_type` to `PrePaid`. If you set `period_unit` to Month, valid values for `period` are 1, 2, 3, 6, and 12. Default value: 1.	0
period_unit	string	The billing cycle of the nodes in the node pool. You must specify this parameter when you set `instance_charge_type` to `PrePaid`. `Month`: The billing cycle is measured in months.	Month
platform	string	The OS distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore` Default value: `AliyunLinux`.	AliyunLinux
rds_instances	array	The list of RDS instances.
	string	The ID of the RDS instance.	rm-2zey3t89t6280****
spot_strategy	string	The policy for the spot instance. Valid values: NoSpot: The instance is a regular on-demand instance. SpotWithPriceLimit: Sets the maximum hourly price for the spot instance. SpotAsPriceGo: The system automatically places a bid, which is the real-time market price. For more information, see Spot instances.	NoSpot
spot_price_limit	array	The market price range configuration for a single spot instance type.
	object
instance_type	string	The spot instance type.	ecs.c6.large
price_limit	string	The maximum price for a single instance.	0.39
scaling_policy	string	The scaling mode of the scaling group. Valid values: `release`: standard mode. Scales ECS instances by creating and releasing them based on resource usage. `recycle`: fast mode. Scales ECS instances by creating, stopping, and starting them. This improves scaling speed. You are not charged for compute resources when an instance is stopped. You are charged only for storage. This does not apply to instance types with local disks. Default value: `release`.	release
security_group_id	string	The ID of the security group for the node pool. This parameter is mutually exclusive with `security_group_ids`. Using `security_group_ids` is recommended.	sg-2zeihch86ooz9io4****
security_group_ids	array	The list of security group IDs. This parameter is mutually exclusive with `security_group_id`. Using `security_group_ids` is recommended. If you specify both `security_group_id` and `security_group_ids`, `security_group_ids` takes precedence.
	string	The security group ID.	sg-2zeihch86ooz9io4****
system_disk_category	string	The type of the system disk for the nodes. 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_categories	array	The list of system disk types. When a disk of a higher-priority type cannot be created, the system automatically tries to create a system disk of the next-priority type. Valid values: cloud: basic disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD.
	string	The type of the system disk for the nodes.	cloud_essd
system_disk_size	integer	The size of the system disk for the nodes. Unit: GiB. Valid values: 40 to 500.	120
system_disk_performance_level	string	The performance level of the system disk for the nodes. This parameter takes effect only for ESSDs. PL0: moderate concurrent I/O performance, stable read and write latency. PL1: moderate concurrent I/O performance, stable read and write latency. PL2: high concurrent I/O performance, stable read and write latency. PL3: extremely high concurrent I/O performance, extremely stable read and write latency.	PL1
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 of the nodes.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	The encryption algorithm used for the system disk of the nodes. Valid value: aes-256.	aes-256
system_disk_provisioned_iops	integer	The pre-configured read/write IOPS of the system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}. You can set this parameter only when `SystemDiskCategory` is set to `cloud_auto`. For more information, see ESSD AutoPL disks.	1000
system_disk_bursting_enabled	boolean	Specifies whether to enable performance burst for the system disk. Valid values: true: yes. false: no. You can set this parameter only when `SystemDiskCategory` is set to `cloud_auto`. For more information, see ESSD AutoPL disks.	true
tags	array	Adds tags only to ECS instances. Tag keys cannot be repeated and can be up to 128 characters long. Tag keys and values cannot start with "aliyun" or "acs:" and cannot contain "https://" or "http://".
	object
key	string	The name of the tag.	key
value	string	The tag value.	value
vswitch_ids	array	The virtual switch ID.
	string	The virtual switch ID.	vsw-2ze0fmpbwo140ahni****
multi_az_policy	string	The scaling policy for ECS instances in a multi-zone scaling group. Valid values: `PRIORITY`: Scales instances based on the virtual switches (VSwitchIds.N) that you define. When an ECS instance cannot be created in the zone of a higher-priority virtual switch, the system automatically uses the next-priority virtual switch to create the instance. `COST_OPTIMIZED`: Attempts to create instances in ascending order of vCPU unit price. If multiple instance types are specified for the scaling configuration and the billing method is spot, the system prioritizes the creation of spot instances. You can use the `CompensateWithOnDemand` parameter to specify whether to automatically try to create on-demand instances when spot instances cannot be created due to reasons such as insufficient inventory. Note `COST_OPTIMIZED` takes effect only when multiple instance types are specified for the scaling configuration or when spot instances are selected. `BALANCE`: Evenly distributes ECS instances across the multiple zones specified for the scaling group. If the zones become unbalanced due to insufficient inventory or other reasons, you can call the RebalanceInstances API to balance the resources. For more information, see RebalanceInstances. Default value: `PRIORITY`.	COST_OPTIMIZED
on_demand_base_capacity	integer	The minimum number of on-demand instances required in the scaling group. Valid values: 0 to 1,000. When the number of on-demand instances is less than this value, the system prioritizes the creation of on-demand instances.	0
on_demand_percentage_above_base_capacity	integer	The percentage of on-demand instances among the excess instances after the minimum number of on-demand instances (`on_demand_base_capacity`) is met. Valid values: 0 to 100.	20
spot_instance_pools	integer	The number of available instance types. The scaling group will create spot instances of multiple lowest-cost types in a balanced manner. Valid values: 1 to 10.	5
spot_instance_remedy	boolean	Specifies whether to enable replenishment for spot instances. When enabled, the scaling group attempts to create a new instance to replace a spot instance that is about to be reclaimed after receiving a system message about the reclamation. Valid values: `true`: Enables replenishment for spot instances. `false`: Disables replenishment for spot instances.	false
compensate_with_on_demand	boolean	When `multi_az_policy` is set to `COST_OPTIMIZED`, specifies whether to allow the system to automatically try to create on-demand instances to meet the required number of ECS instances if sufficient spot instances cannot be created due to price or inventory issues. Valid values: `true`: Allows the system to automatically try to create on-demand instances to meet the required number of ECS instances. `false`: Does not allow the system to automatically try to create on-demand instances to meet the required number of ECS instances.	true
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 of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.	10
image_type	string	The type of the OS image. This parameter is mutually exclusive with the platform parameter. Valid values: `AliyunLinux`: Alinux2 image. `AliyunLinux3`: Alinux3 image. `AliyunLinux3Arm64`: Alinux3 ARM image. `AliyunLinuxUEFI`: Alinux2 UEFI image. `CentOS`: CentOS image. `Windows`: Windows image. `WindowsCore`: WindowsCore image. `ContainerOS`: Container-optimized image.	AliyunLinux
deploymentset_id	string	The deployment set ID.	ds-bp1d19mmbsv3jf6xxxxx
desired_size	integer	The desired number of nodes in the node pool.	2
private_pool_options	object	The private node pool configuration.
id	string	The ID of the private node pool.	eap-bp67acfmxazb4****
match_criteria	string	The type of the private node pool. This is the capacity option for the private pool from which instances are launched. After an Elasticity Assurance or a Capacity Reservation service takes effect, it generates a private pool of capacity for instance launches. Valid values: `Open`: open mode. The system automatically matches the capacity of open-type private pools. If no eligible private pool capacity is found, the instance is launched using public pool resources. `Target`: targeted mode. The instance is launched from the capacity of a specified private pool. If the specified private pool capacity is unavailable, the instance launch fails. `None`: no-use mode. The instance is launched without using private pool capacity.	Open
ram_role_name	string	The name of the worker RAM role. Important Only ACK managed clusters of Kubernetes 1.22 or later support this parameter when you create a node pool.	example-role
instance_metadata_options	InstanceMetadataOptions	The metadata access configuration for the ECS instance. This feature is available only to users on the whitelist. To use this feature, submit a ticket.
resource_pool_options	object	The resource pool and its policy used when creating instances. When you set this parameter, note the following: This parameter is effective only when creating pay-as-you-go instances. This parameter cannot be set at the same time as private_pool_options.match_criteria or private_pool_options.id.
strategy	string	The resource pool policy used when creating instances. A resource pool includes private pools generated after an Elasticity Assurance or a Capacity Reservation service takes effect, along with public pools, for instance launches. Valid values: PrivatePoolFirst: Private pool first. With this policy, if resource_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pools have insufficient capacity, the system automatically matches open-type private pools. If no eligible private pools are found, the instance is created using the public pool. PrivatePoolOnly: Private pool only. With this policy, you must specify resource_pool_options.private_pool_ids. If the specified private pools have insufficient capacity, the instance launch fails. None: No resource pool policy is used. Default value: None.	PrivatePoolFirst
private_pool_ids	array	The list of private pool IDs. These are the IDs of Elasticity Assurance or Capacity Reservation services. You can only pass the IDs of private pools in Target mode. The value of N can be from 1 to 20.
	string	The private pool ID. This is the ID of an Elasticity Assurance or a Capacity Reservation service. You can only pass the IDs of private pools in Target mode.	eap-bp67acfmxazb4****
tee_config	object	The confidential computing node pool configuration.
tee_enable	boolean	Specifies whether the node pool is a confidential computing node pool.	false
management	object	The managed node pool configuration.
enable	boolean	Specifies whether to enable the managed node pool feature. Valid values: `true`: Enables the managed node pool feature. `false`: Does not enable the managed node pool feature. Other related configurations take effect only when enable is set to true.	false
auto_repair	boolean	Auto repair. This parameter takes effect only when `enable=true`. `true`: Enables auto repair. `false`: Disables auto repair.	false
upgrade_config	object	The auto-upgrade configuration. This parameter takes effect only when `enable=true`.
auto_upgrade	boolean	Specifies whether to enable auto upgrade. Valid values: `true`: Enables auto upgrade. `false`: Disables auto upgrade.	false
surge	integer	The number of extra nodes.	0
surge_percentage	integer	The percentage of extra nodes. This parameter is mutually exclusive with `surge`.	0
max_unavailable	integer	The maximum number of unavailable nodes. Valid values: 1 to 1,000. Default value: 1.	0
auto_repair_policy	object	The auto repair policy for nodes.
restart_node	boolean	Specifies whether to allow node restarts.	true
auto_vul_fix	boolean	Specifies whether to automatically fix 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 for auto-fixing, separated by commas.	asap,nntf
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 auto-upgrading the kubelet.	true
auto_fault_diagnosis	boolean
count	integer	[This parameter is deprecated. Use desired_size instead.] The number of nodes in the node pool.	1
interconnect_mode	string	The network type of the edge node pool. This parameter is valid only for node pools of the `edge` type. Valid values: `basic`: basic. `private`: dedicated. Supported by Kubernetes 1.22 and later.	basic
interconnect_config	object	[This parameter is deprecated] The edge node pool configuration.
cen_id	string	[This parameter is deprecated] The ID of the CEN instance attached to the enhanced edge node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[This parameter is deprecated] The ID of the CCN instance attached to the enhanced edge node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[This parameter is deprecated] The region of the CCN instance attached to the enhanced edge node pool.	cn-shanghai
bandwidth	integer	[This parameter is deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbit/s.	10
improved_period	string	[This parameter is deprecated] The subscription duration of the enhanced edge node pool. Unit: month.	1
max_nodes	integer	The maximum number of nodes that an edge node pool can contain. The value must be greater than or equal to 0. A value of 0 indicates no extra limit, meaning the number of nodes is limited only by the total capacity of the cluster. The value of this parameter is usually greater than 0 for edge node pools, and 0 for ESS-type node pools and default edge-type node pools.	10
node_config	object	The node configuration.
kubelet_configuration	kubelet_config	The Kubelet parameter configuration.
node_components	array	The list of node components.
	object	The node component.
name	string	The name of the node component.	kubelet
version	string	The version of the node component.	1.33.3-aliyun.1
config	object	The configuration of the node component.
custom_config	object	The custom configuration of the node component.
	string	The custom configuration string of the node component.	cpuManagerPolicy

object

The node pool.

auto_scaling

object

The configurations of the auto scaling node pool.

enable

boolean

Specifies whether to enable auto scaling.

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

Default value: false.

true

max_instances

integer

The maximum number of instances in the scaling group.

10

min_instances

integer

The minimum number of instances in the scaling group.

0

type

string

The type of auto scaling. This parameter is specified based on the instance type for auto scaling. Valid values:

cpu: regular instances.
gpu: GPU-accelerated instances.
gpushare: shared GPU-accelerated instances.
spot: spot instances.

Default value: cpu.

cpu

is_bond_eip

boolean

[This parameter is deprecated]

Specifies whether to associate an EIP. Valid values:

true: Associates an EIP.
false: Does not associate an EIP.

Default value: false.

true

eip_internet_charge_type

string

[This parameter is deprecated]

The billing method of the EIP. Valid values:

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

Default value: PayByBandwidth.

PayByBandwidth

eip_bandwidth

integer

[This parameter is deprecated]

The peak bandwidth of the EIP. Unit: Mbit/s.

5

kubernetes_config

object

The cluster configurations.

cms_enabled

boolean

Specifies whether to install Cloud Monitor on ECS nodes. After installation, you can view monitoring data of the created ECS instances in the Cloud Monitor console. This feature is recommended. Valid values:

true: Installs Cloud Monitor on ECS nodes.
false: Does not install Cloud Monitor on ECS nodes.

Default value: false.

true

cpu_policy

string

The CPU management policy for the node. The following policies are supported for clusters of Kubernetes 1.12.6 or later:

static: allows pods with specific resource characteristics on a node to have enhanced CPU affinity and exclusivity.
none: enables the default CPU affinity policy.

Default value: none.

none

labels

array

The node labels. Add labels to the nodes of the Kubernetes cluster.

tag

The node label.

runtime

string

The container runtime. Valid values:

containerd: This container runtime is recommended and supported by all cluster versions.
Sandboxed-Container.runv: a sandboxed container that provides a higher level of isolation. This container runtime is supported by clusters of Kubernetes 1.24 or earlier.
docker: This container runtime is supported by clusters of Kubernetes 1.22 or earlier.

Default value: containerd

containerd

runtime_version

string

The container runtime version.

1.6.20

taints

array

The taint configuration.

taint

The taint configuration.

user_data

string

The custom data of the node.

MXM=

node_name_mode

string

The node name consists of a prefix, the node IP address, and a suffix.

The prefix and suffix can contain 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 consists of four parts separated by commas. For example, if you pass the string "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

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 configurations of the scaling group for the node pool.

auto_renew

boolean

Specifies whether to enable auto-renewal for 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.

false

auto_renew_period

integer

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

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

Default value: 1.

0

data_disks

array

The data disk configurations of the nodes in the node pool.

data_disk

The data disk configurations of the nodes in the node pool.

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-provided image is used.

aliyun_2_1903_x64_20G_alibase_20200904.vhd

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_types

array

The instance type.

string

The instance type.

ecs.n1.medium

key_pair

string

The name of the key pair. This parameter is mutually exclusive with login_password.

Note

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

np-key

The SSH logon password. This parameter is mutually exclusive with key_pair. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

period

integer

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

Default value: 1.

0

period_unit

string

The billing cycle of the nodes in the node pool. You must specify this parameter when you set instance_charge_type to PrePaid.

Month: The billing cycle is measured in months.

Month

platform

string

The OS distribution. Valid values:

CentOS
AliyunLinux
Windows
WindowsCore

Default value: AliyunLinux.

AliyunLinux

rds_instances

array

The list of RDS instances.

string

The ID of the RDS instance.

rm-2zey3t89t6280****

spot_strategy

string

The policy for the spot instance. Valid values:

NoSpot: The instance is a regular on-demand instance.
SpotWithPriceLimit: Sets the maximum hourly price for the spot instance.
SpotAsPriceGo: The system automatically places a bid, which is the real-time market price.

For more information, see Spot instances.

NoSpot

spot_price_limit

array

The market price range configuration for a single spot instance type.

object

instance_type

string

The spot instance type.

ecs.c6.large

price_limit

string

The maximum price for a single instance.

0.39

scaling_policy

string

The scaling mode of the scaling group. Valid values:

release: standard mode. Scales ECS instances by creating and releasing them based on resource usage.
recycle: fast mode. Scales ECS instances by creating, stopping, and starting them. This improves scaling speed. You are not charged for compute resources when an instance is stopped. You are charged only for storage. This does not apply to instance types with local disks.

Default value: release.

release

security_group_id

string

The ID of the security group for the node pool. This parameter is mutually exclusive with security_group_ids. Using security_group_ids is recommended.

sg-2zeihch86ooz9io4****

security_group_ids

array

The list of security group IDs. This parameter is mutually exclusive with security_group_id. Using security_group_ids is recommended. If you specify both security_group_id and security_group_ids, security_group_ids takes precedence.

string

The security group ID.

sg-2zeihch86ooz9io4****

system_disk_category

string

The type of the system disk for the nodes. 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_categories

array

The list of system disk types. When a disk of a higher-priority type cannot be created, the system automatically tries to create a system disk of the next-priority type. Valid values:

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

string

The type of the system disk for the nodes.

cloud_essd

system_disk_size

integer

The size of the system disk for the nodes. Unit: GiB.

Valid values: 40 to 500.

120

system_disk_performance_level

string

The performance level of the system disk for the nodes. This parameter takes effect only for ESSDs.

PL0: moderate concurrent I/O performance, stable read and write latency.
PL1: moderate concurrent I/O performance, stable read and write latency.
PL2: high concurrent I/O performance, stable read and write latency.
PL3: extremely high concurrent I/O performance, extremely stable read and write latency.

PL1

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 of the nodes.

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

system_disk_encrypt_algorithm

string

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

aes-256

system_disk_provisioned_iops

integer

The pre-configured read/write IOPS of the system disk. Valid values: 0 to min{50,000, 1,000 × Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 × Capacity, 50,000}.

You can set this parameter only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks.

1000

system_disk_bursting_enabled

boolean

Specifies whether to enable performance burst for the system disk. Valid values:

true: yes.
false: no.

You can set this parameter only when SystemDiskCategory is set to cloud_auto. For more information, see ESSD AutoPL disks.

true

tags

array

Adds tags only to ECS instances.

Tag keys cannot be repeated and can be up to 128 characters long. Tag keys and values cannot start with "aliyun" or "acs:" and cannot contain "https://" or "http://".

object

key

string

The name of the tag.

key

value

string

The tag value.

value

vswitch_ids

array

The virtual switch ID.

string

The virtual switch ID.

vsw-2ze0fmpbwo140ahni****

multi_az_policy

string

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

PRIORITY: Scales instances based on the virtual switches (VSwitchIds.N) that you define. When an ECS instance cannot be created in the zone of a higher-priority virtual switch, the system automatically uses the next-priority virtual switch to create the instance.
COST_OPTIMIZED: Attempts to create instances in ascending order of vCPU unit price. If multiple instance types are specified for the scaling configuration and the billing method is spot, the system prioritizes the creation of spot instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically try to create on-demand instances when spot instances cannot be created due to reasons such as insufficient inventory.

Note
COST_OPTIMIZED takes effect only when multiple instance types are specified for the scaling configuration or when spot instances are selected.
BALANCE: Evenly distributes ECS instances across the multiple zones specified for the scaling group. If the zones become unbalanced due to insufficient inventory or other reasons, you can call the RebalanceInstances API to balance the resources. For more information, see RebalanceInstances.

Default value: PRIORITY.

COST_OPTIMIZED

on_demand_base_capacity

integer

The minimum number of on-demand instances required in the scaling group. Valid values: 0 to 1,000. When the number of on-demand instances is less than this value, the system prioritizes the creation of on-demand instances.

0

on_demand_percentage_above_base_capacity

integer

The percentage of on-demand instances among the excess instances after the minimum number of on-demand instances (on_demand_base_capacity) is met. Valid values: 0 to 100.

20

spot_instance_pools

integer

The number of available instance types. The scaling group will create spot instances of multiple lowest-cost types in a balanced manner. Valid values: 1 to 10.

5

spot_instance_remedy

boolean

Specifies whether to enable replenishment for spot instances. When enabled, the scaling group attempts to create a new instance to replace a spot instance that is about to be reclaimed after receiving a system message about the reclamation. Valid values:

true: Enables replenishment for spot instances.
false: Disables replenishment for spot instances.

false

compensate_with_on_demand

boolean

When multi_az_policy is set to COST_OPTIMIZED, specifies whether to allow the system to automatically try to create on-demand instances to meet the required number of ECS instances if sufficient spot instances cannot be created due to price or inventory issues. Valid values:

true: Allows the system to automatically try to create on-demand instances to meet the required number of ECS instances.
false: Does not allow the system to automatically try to create on-demand instances to meet the required number of ECS instances.

true

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 of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.

10

image_type

string

The type of the OS image. This parameter is mutually exclusive with the platform parameter. Valid values:

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

AliyunLinux

deploymentset_id

string

The deployment set ID.

ds-bp1d19mmbsv3jf6xxxxx

desired_size

integer

The desired number of nodes in the node pool.

2

private_pool_options

object

The private node pool configuration.

id

string

The ID of the private node pool.

eap-bp67acfmxazb4****

match_criteria

string

The type of the private node pool. This is the capacity option for the private pool from which instances are launched. After an Elasticity Assurance or a Capacity Reservation service takes effect, it generates a private pool of capacity for instance launches. Valid values:

Open: open mode. The system automatically matches the capacity of open-type private pools. If no eligible private pool capacity is found, the instance is launched using public pool resources.
Target: targeted mode. The instance is launched from the capacity of a specified private pool. If the specified private pool capacity is unavailable, the instance launch fails.
None: no-use mode. The instance is launched without using private pool capacity.

Open

ram_role_name

string

The name of the worker RAM role.

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

example-role

instance_metadata_options

InstanceMetadataOptions

The metadata access configuration for the ECS instance. This feature is available only to users on the whitelist. To use this feature, submit a ticket.

resource_pool_options

object

The resource pool and its policy used when creating instances. When you set this parameter, note the following: This parameter is effective only when creating pay-as-you-go instances. This parameter cannot be set at the same time as private_pool_options.match_criteria or private_pool_options.id.

strategy

string

The resource pool policy used when creating instances. A resource pool includes private pools generated after an Elasticity Assurance or a Capacity Reservation service takes effect, along with public pools, for instance launches. Valid values: PrivatePoolFirst: Private pool first. With this policy, if resource_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pools have insufficient capacity, the system automatically matches open-type private pools. If no eligible private pools are found, the instance is created using the public pool. PrivatePoolOnly: Private pool only. With this policy, you must specify resource_pool_options.private_pool_ids. If the specified private pools have insufficient capacity, the instance launch fails. None: No resource pool policy is used. Default value: None.

PrivatePoolFirst

private_pool_ids

array

The list of private pool IDs. These are the IDs of Elasticity Assurance or Capacity Reservation services. You can only pass the IDs of private pools in Target mode. The value of N can be from 1 to 20.

string

The private pool ID. This is the ID of an Elasticity Assurance or a Capacity Reservation service. You can only pass the IDs of private pools in Target mode.

eap-bp67acfmxazb4****

tee_config

object

The confidential computing node pool configuration.

tee_enable

boolean

Specifies whether the node pool is a confidential computing node pool.

false

management

object

The managed node pool configuration.

enable

boolean

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

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

false

auto_repair

boolean

Auto repair. This parameter takes effect only when enable=true.

true: Enables auto repair.
false: Disables auto repair.

false

upgrade_config

object

The auto-upgrade configuration. This parameter takes effect only when enable=true.

auto_upgrade

boolean

Specifies whether to enable auto upgrade. Valid values:

true: Enables auto upgrade.
false: Disables auto upgrade.

false

surge

integer

The number of extra nodes.

0

surge_percentage

integer

The percentage of extra nodes. This parameter is mutually exclusive with surge.

0

max_unavailable

integer

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

Default value: 1.

0

auto_repair_policy

object

The auto repair policy for nodes.

restart_node

boolean

Specifies whether to allow node restarts.

true

auto_vul_fix

boolean

Specifies whether to automatically fix 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 for auto-fixing, separated by commas.

asap,nntf

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 auto-upgrading the kubelet.

true

auto_fault_diagnosis

boolean

count

integer

[This parameter is deprecated. Use desired_size instead.]

The number of nodes in the node pool.

1

interconnect_mode

string

The network type of the edge node pool. This parameter is valid only for node pools of the edge type. Valid values:

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

basic

interconnect_config

object

[This parameter is deprecated]

The edge node pool configuration.

cen_id

string

[This parameter is deprecated]

The ID of the CEN instance attached to the enhanced edge node pool.

cen-ey9k9nfhz0f*******

ccn_id

string

[This parameter is deprecated]

The ID of the CCN instance attached to the enhanced edge node pool.

ccn-qm5i0i0q9yi*******

ccn_region_id

string

[This parameter is deprecated]

The region of the CCN instance attached to the enhanced edge node pool.

cn-shanghai

bandwidth

integer

[This parameter is deprecated]

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

10

improved_period

string

[This parameter is deprecated]

The subscription duration of the enhanced edge node pool. Unit: month.

1

max_nodes

integer

The maximum number of nodes that an edge node pool can contain. The value must be greater than or equal to 0. A value of 0 indicates no extra limit, meaning the number of nodes is limited only by the total capacity of the cluster. The value of this parameter is usually greater than 0 for edge node pools, and 0 for ESS-type node pools and default edge-type node pools.

10

node_config

object

The node configuration.

kubelet_configuration

kubelet_config

The Kubelet parameter configuration.

node_components

array

The list of node components.

object

The node component.

name

string

The name of the node component.

kubelet

version

string

The version of the node component.

1.33.3-aliyun.1

config

object

The configuration of the node component.

custom_config

object

The custom configuration of the node component.

string

The custom configuration string of the node component.

cpuManagerPolicy