Provision ACK Serverless Node Pools via CreateClusterNodePool API - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

A node pool is a logical collection of nodes that share the same attributes, allowing unified management and operations such as node upgrades and elastic scaling. You can further use the automated O&M capabilities of node pools, including automatic OS CVE vulnerability patching, automatic faulty node recovery, and automatic kubelet and containerd version upgrades, to reduce O&M costs. You can call CreateClusterNodePool to create a node pool for a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:CreateClusterNodePool

create

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

POST /clusters/{ClusterId}/nodepools HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c61da77e8bfbc4c4c999af2b51b65****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
nodepool_info	object	No	The node pool configuration.
name	string	Yes	The node pool name.	nodepool-test
type	string	No	The node pool type. Valid values: `ess`: standard node pool (includes managed features and automatic elastic scaling). `edge`: edge node pool. `lingjun`: Lingjun node pool. `hybrid`: hybrid cloud node pool. Valid values: lingjun : Lingjun node pool. edge : Edge node pool. ess : Standard node pool.	ess
resource_group_id	string	No	The resource group ID of the node pool. Instances scaled out by the node pool belong to this resource group. A resource can belong to only one resource group. You can map resource groups to concepts such as projects, applications, or organizations based on your business scenarios.	rg-acfmyvw3wjmb****
auto_scaling	object	No	The automatic elastic scaling configuration.
enable	boolean	No	Specifies whether to enable automatic scaling. Valid values: `true`: enables automatic scaling for the node pool. When the cluster capacity planning cannot meet the scheduling requirements of application pods, ACK automatically scales node resources based on the configured minimum and maximum instance counts. Clusters of version 1.24 and later use instant node elasticity by default. Clusters of versions earlier than 1.24 use node auto scaling by default. For more information, see Node scaling. `false`: disables automatic scaling. ACK adjusts the number of nodes in the node pool based on the configured desired node count and maintains the node count at the desired value. When the value is false, other configuration parameters in `auto_scaling` do not take effect. Default value: `false`.	false
type	string	No	The instance type for automatic elastic scaling. This parameter takes effect only when `enable=true`. Valid values: `cpu`: regular instance type. `gpu`: GPU instance type. `gpushare`: GPU-shared type. `spot`: spot instance type. Default value: `cpu`. Important This field cannot be modified after the node pool is created. Valid values: spot : Spot instance type. cpu : Regular instance type. gpushare : GPU-shared type. gpu : GPU instance type.	cpu
max_instances	integer	No	The maximum number of instances that can be scaled in the node pool, excluding your existing instances. This parameter takes effect only when `enable=true`. Valid values: [min_instances, 2000]. Default value: 0.	10
min_instances	integer	No	The minimum number of instances that can be scaled in the node pool, excluding your existing instances. This parameter takes effect only when `enable=true`. Valid values: [0, max_instances]. Default value: 0. Note If the minimum number of instances is not 0, the scaling group triggers automatic creation of the corresponding number of ECS instances after the settings take effect. Set the maximum number of instances to a value that is not less than the current number of nodes in the node pool. Otherwise, nodes in the node pool are scaled in after the elastic scaling feature takes effect.	1
is_bond_eip `deprecated`	boolean	No	[Deprecated] This field is deprecated. Use internet_charge_type and internet_max_bandwidth_out instead. Specifies whether to associate an elastic IP address (EIP). Valid values: `true`: associates an EIP. `false`: does not associate an EIP. Default value: `false`.	null
eip_internet_charge_type `deprecated`	string	No	[Deprecated] Use internet_charge_type and internet_max_bandwidth_out instead. The billing method of the EIP. Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-data-transfer. Default value: `PayByBandwidth`.	null
eip_bandwidth `deprecated`	integer	No	[Deprecated] Use internet_charge_type and internet_max_bandwidth_out instead. The peak bandwidth of the EIP. Unit: Mbit/s.	null
management	object	No	The managed feature configuration for the node pool.
enable	boolean	No	Specifies whether to enable the managed feature for the node pool. Valid values: `true`: enables the managed feature. `false`: disables the managed feature. Other related configurations take effect only when enable=true. Default value: false.	false
auto_repair	boolean	No	Specifies whether to automatically repair nodes. This parameter takes effect only when `enable=true`. `true`: automatically repairs nodes. `false`: does not automatically repair nodes. Default value: `true`.	true
auto_repair_policy	object	No	The auto repair node policy.
restart_node	boolean	No	Whether to allow node restart. Takes effect only when `auto_repair=true`. Valid values: `true`: allow node restart `false`: do not allow node restart Default value: `true`	true
approval_required	boolean	No	Whether node repair requires manual approval.
auto_vul_fix	boolean	No	Specifies whether to automatically fix CVE vulnerabilities. This parameter takes effect only when `enable=true`. `true`: allows automatic CVE fixing. `false`: does not allow automatic CVE fixing. Default value: `true`.	true
auto_vul_fix_policy	object	No	The auto CVE fix policy.
restart_node	boolean	No	Whether to allow node restart. Takes effect only when `auto_vul_fix=true`. Valid values: `true`: allow node restart `false`: do not allow node restart Default value: `true`	false
vul_level	string	No	Vulnerability levels allowed for automatic fixing, separated by commas, for example: `asap,later`. Supported vulnerability levels: `asap`: high `later`: medium `nntf`: low Default value: `asap`.	asap,nntf
exclude_packages	string	No	Packages to exclude during vulnerability patching. Default value: `kernel`.	kernel
auto_upgrade	boolean	No	Specifies whether to automatically upgrade nodes. This parameter takes effect only when `enable=true`. `true`: enables automatic upgrade. `false`: disables automatic upgrade. Default value: `true`.	true
auto_upgrade_policy	object	No	The auto upgrade node policy.
auto_upgrade_kubelet	boolean	No	Whether to allow automatic kubelet upgrade. Takes effect only when `auto_upgrade=true`. Valid values: `true`: allow automatic kubelet upgrade. `false`: do not allow automatic kubelet upgrade. Default value: `true`.	true
auto_upgrade_runtime	boolean	No	Whether to allow automatic runtime upgrade. Takes effect only when `auto_upgrade=true`. Valid values: `true`: allow automatic runtime upgrade. `false`: do not allow automatic runtime upgrade. Default value: `true`.	false
auto_upgrade_os	boolean	No	Whether to allow automatic OS upgrade. Takes effect only when `auto_upgrade=true`. Valid values: `true`: allow automatic OS upgrade. `false`: do not allow automatic OS upgrade. Default value: `false`.	false
upgrade_config `deprecated`	object	No	[Deprecated] Use the `auto_upgrade` parameter at the upper level instead. The automatic upgrade configuration. This parameter takes effect only when `enable=true`.
auto_upgrade `deprecated`	boolean	No	[Deprecated] Use the `auto_upgrade` parameter at the parent level instead. Whether to enable auto upgrade. Valid values: `true`: enable auto upgrade. `false`: disable auto upgrade.	null
surge	integer	No	Number of extra nodes. Mutually exclusive with `surge_percentage`. Nodes become unavailable during upgrade. You can create extra nodes to compensate for the cluster workload. Note It is recommended that the number of extra nodes does not exceed the current number of nodes.	0
surge_percentage	integer	No	Percentage of extra nodes. Mutually exclusive with `surge`. Number of extra nodes = percentage of extra nodes × number of nodes. For example, if the percentage is set to 50% and there are 6 existing nodes, the number of extra nodes = 50% × 6 = 3.	0
max_unavailable	integer	No	Maximum number of unavailable nodes. Valid values: [1,1000] Default value: 1.	1
auto_fault_diagnosis	boolean	No
scaling_group	object	No	The scaling group configuration for the node pool.
vswitch_ids	array	Yes	The list of vSwitch IDs. Valid values: [1,8]. Note To ensure high availability, select vSwitches in different zones.
	string	No	The vSwitch ID.	vsw-wz9mfnhmssud6eicu****
instance_types	array	Yes	The list of instance types for the node pool. When the node pool scales out nodes, it selects eligible instance types from this list to create instances. The number of supported instance types ranges from 1 to 10. Note To ensure high availability, select multiple instance types.
	string	No	The instance type. For more information, see Instance families.	ecs.d1ne.2xlarge
instance_charge_type	string	Yes	The billing method of nodes in the node pool. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go. Default value: `PostPaid`. Valid values: PostPaid : Pay-as-you-go. PrePaid : Subscription.	PostPaid
period	integer	No	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=Week`, valid values of `period`: {1, 2, 3, 4}. When `period_unit=Month`, valid values of `period`: {1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60}.	1
period_unit	string	No	The billing period unit of nodes in the node pool. This parameter takes effect and is required only when `instance_charge_type` is set to `PrePaid`. `Month`: uses month as the billing period unit. `Week`: uses week as the billing period unit. 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 `instance_charge_type` is set to `PrePaid`. Valid values: `true`: enables auto-renewal. `false`: disables auto-renewal. Default value: `false`.	true
auto_renew_period	integer	No	The auto-renewal duration for a single renewal cycle. Valid values: When PeriodUnit=Week: 1, 2, 3. When PeriodUnit=Month: 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value: 1.	1
spot_strategy	string	No	The bidding policy for spot instances. Valid values: `NoSpot`: non-spot instance. `SpotWithPriceLimit`: spot instance with a price limit. `SpotAsPriceGo`: system automatically bids at the current market price. For more information, see Spot instances.	NoSpot
spot_price_limit	array<object>	No	The market price range configuration for a single spot instance type.
	object	No	The market price range configuration for spot instances. You can set different price ranges for different instance types.
instance_type	string	No	Preemptible instance type.	ecs.c6.large
price_limit	string	No	Maximum price per instance. Unit: USD/hour.	0.39
image_type	string	No	The operating system image type. Valid values: `AliyunLinux`: Alinux2 image. `AliyunLinuxSecurity`: Alinux2 UEFI image. `AliyunLinux3`: Alinux3 image. `AliyunLinux3Arm64`: Alinux3 ARM image. `AliyunLinux3Security`: Alinux3 UEFI image. `CentOS`: CentOS image. `Windows`: Windows image. `WindowsCore`: WindowsCore image. `ContainerOS`: container-optimized image. `AliyunLinux3ContainerOptimized`: Alinux3 container-optimized image.	AliyunLinux3
image_id	string	No	The custom image ID. The system-provided image is used by default.	aliyun_2_1903_x64_20G_alibase_20200529.vhd
system_disk_category	string	No	The type of the node system cloud disk. Valid values: `cloud_efficiency`: ultra cloud disk. `cloud_ssd`: standard SSD. `cloud_essd`: ESSD. `cloud_auto`: ESSD AutoPL cloud disk. `cloud_essd_entry`: ESSD Entry cloud disk. Default value: `cloud_efficiency`.	cloud_efficiency
system_disk_categories	array	No	Multiple system cloud disk types. When a higher-priority cloud disk type is unavailable, the system automatically tries the next-priority cloud disk type to create the system cloud disk.
	string	No	The multiple system cloud disk types for nodes. Valid values: `cloud`: basic cloud disk. `cloud_efficiency`: ultra cloud disk. `cloud_ssd`: standard SSD. `cloud_essd`: ESSD. `cloud_auto`: ESSD AutoPL cloud disk. `cloud_essd_entry`: ESSD Entry disk.	cloud_essd
system_disk_size	integer	No	The size of the node system cloud disk. Unit: GiB. Valid values: [20,2048].	120
system_disk_performance_level	string	No	The performance level of the node system cloud disk. This parameter takes effect only for ESSD cloud disks. The performance level varies based on the cloud disk size. For more information, see ESSD cloud disks. PL0: moderate maximum concurrent I/O performance with relatively stable read/write latency. PL1: moderate maximum concurrent I/O performance with relatively stable read/write latency. PL2: high maximum concurrent I/O performance with stable read/write latency. PL3: ultra-high maximum concurrent I/O performance with extremely stable read/write latency.	PL1
system_disk_encrypted	boolean	No	Specifies whether to encrypt the system cloud disk. Valid values: true: Encrypted. false: Not encrypted.	false
system_disk_kms_key_id	string	No	The KMS key ID used for the system cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	No	The encryption algorithm for the system cloud disk. Valid values: aes-256.	aes-256
system_disk_bursting_enabled	boolean	No	Specifies whether to enable burst (performance burst) for the node system cloud disk. Valid values: true: Enabled. false: Disabled. This parameter is supported only when `system_disk_category` is set to `cloud_auto`. For more information, see ESSD AutoPL cloud disks.	true
system_disk_provisioned_iops	integer	No	The provisioned read/write IOPS for the node system cloud disk. Valid values: 0 to min{50,000, 1000 × capacity - baseline performance}. Baseline performance = min{1,800 + 50 × capacity, 50000}. This parameter is supported only when `system_disk_category` is set to `cloud_auto`. For more information, see ESSD AutoPL cloud disks.	1000
data_disks	array	No	The data cloud disk configuration for nodes in the node pool.
	data_disk	No	The data cloud disk configuration.
security_group_ids	array	No	The list of security group IDs. Specify either this parameter or `security_group_id`. We recommend that you use `security_group_ids`. If both `security_group_id` and `security_group_ids` are specified, `security_group_ids` takes precedence.
	string	No	The list of security group IDs. Specify either this parameter or `security_group_id`. We recommend that you use `security_group_ids`. If both `security_group_id` and `security_group_ids` are specified, `security_group_ids` takes precedence.	sg-wz9a8g2mt6x5ll******
key_pair	string	No	The name of the key pair for password-free logon. Specify either this parameter or `login_password`. Note If the node pool uses the ContainerOS operating system, only `key_pair` is supported.	np-key-name
login_password	string	No	The SSH logon password. Specify either 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.	****
login_as_non_root	boolean	No	Specifies whether scaled-out ECS instances use non-root logon. true: logs on as a non-root user (ecs-user). false: logs on as the root user.	true
cis_enabled `deprecated`	boolean	No	[Deprecated] Use the security_hardening_os parameter instead.	null
soc_enabled	boolean	No	Specifies whether to enable mlps 2.0 security hardening. This feature is available only when the system image is Alibaba Cloud Linux 2 or Alibaba Cloud Linux 3. Alibaba Cloud provides classified protection compliance baseline check standards and scanning programs for Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3 MLPS 2.0 level 3 images.	false
security_hardening_os	boolean	No	Specifies whether to enable Alibaba Cloud OS security hardening. Valid values: `true`: enables Alibaba Cloud OS security hardening. `false`: disables Alibaba Cloud OS security hardening. Default value: `false`.	false
internet_charge_type	string	No	The billing method for public IP addresses. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-data-transfer.	PayByTraffic
internet_max_bandwidth_out	integer	No	The maximum outbound public bandwidth for nodes. Unit: Mbit/s. Valid values: [1,100].	5
tags	array<object>	No	Tags added only to ECS instances. Tag keys cannot be duplicated 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	No	The node tag.
key	string	No	Tag key.	node-k-1
value	string	No	Tag value.	node-v-1
desired_size	integer	No	The desired number of nodes in the node pool. The total number of nodes that the node pool should maintain. We recommend that you configure at least 2 nodes to ensure that cluster components run properly. You can scale the node pool in or out by adjusting the desired node count. If you do not need to create nodes, set this parameter to 0 and manually adjust the value later to add nodes.	0
multi_az_policy	string	No	The scaling policy for ECS instances in a multi-zone scaling group. Valid values: `PRIORITY`: Scales based on the vSwitches (VSwitchIds.N) you define. When ECS instances cannot be created in the zone of a higher-priority vSwitch, the system automatically uses the next-priority vSwitch to create ECS instances. `COST_OPTIMIZED`: Attempts to create instances in order of vCPU unit price from lowest to highest. When the scaling configuration specifies multiple instance types with the preemptible billing method, spot instances are created first. You can use the `CompensateWithOnDemand` parameter to specify whether the system is allowed to automatically attempt to create pay-as-you-go instances when spot instances cannot be created due to insufficient inventory. Note `COST_OPTIMIZED` takes effect only when the scaling configuration specifies multiple instance types or uses spot instances. `BALANCE`: Evenly allocates ECS instances across the multiple active zones specified in the scaling group. If zones become unbalanced due to insufficient inventory, you can use the RebalanceInstances API to rebalance resources. Default value: `PRIORITY`.	COST_OPTIMIZED
scaling_policy	string	No	The scaling group mode. Valid values: `release`: Standard mode. Scales by creating and releasing ECS instances based on resource usage. `recycle`: Swift mode. Scales by creating, stopping, and starting instances, which improves subsequent scaling speed. Stopped instances are not charged for compute resources, only for storage. This does not apply to instances with local disks. Default value: `release`.	release
on_demand_base_capacity	integer	No	The minimum number of pay-as-you-go instances required in the scaling group. Valid values: [0,1000]. Pay-as-you-go instances are created first when the number of pay-as-you-go instances is less than this value.	0
on_demand_percentage_above_base_capacity	integer	No	The percentage of pay-as-you-go instances among the excess instances after the minimum number of pay-as-you-go instances (`on_demand_base_capacity`) is met. Valid values: [0,100].	20
spot_instance_pools	integer	No	The number of available instance types. The scaling group creates spot instances across the lowest-cost instance types in a balanced manner. Valid values: [1,10].	5
spot_instance_remedy	boolean	No	Specifies whether to enable supplementing spot instances. When enabled, the scaling group attempts to create new instances to replace spot instances that are about to be reclaimed. Valid values: `true`: Enables supplementing spot instances. `false`: Disables supplementing spot instances.	false
compensate_with_on_demand	boolean	No	When `multi_az_policy` is set to `COST_OPTIMIZED`, specifies whether to allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements if spot instances cannot be created due to price or inventory reasons. Valid values: `true`: Allows automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements. `false`: Does not allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements.	true
deploymentset_id	string	No	The deployment set ID. You can use a deployment set to distribute ECS instances scaled out by the node pool across different physical servers to ensure high availability and underlying disaster recovery. When creating ECS instances within a deployment set, instances are launched in the specified region based on the pre-configured deployment strategy. Important After you select a deployment set, the maximum number of nodes in the node pool is limited. By default, a deployment set supports up to 20 × number of zones (the number of zones is determined by the vSwitches). Choose carefully and ensure sufficient quota in the deployment set to avoid node scale-out failures.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	No	The list of RDS instances.
	string	No	The RDS instance ID.	rds-****
private_pool_options	object	No	The private node pool configuration.
id	string	No	Private pool ID. When `match_criteria` is set to `Target`, you must further specify the private pool ID.	eap-bp67acfmxazb4****
match_criteria	string	No	Private pool type. Private pool capacity option for instance startup. After an Elasticity Assurance or Capacity Reservation takes effect, private pool capacity is generated for instance startup. Valid values: `Open`: open mode. Automatically matches open-type private pool capacity. If no eligible private pool capacity is available, public pool resources are used. `Target`: targeted mode. Uses the specified private pool capacity to launch instances. If the specified capacity is unavailable, instance creation fails. `None`: do not use mode. Instances will not use private pool capacity.	Target
security_group_id `deprecated`	string	No	The security group ID of the node pool. Use either this parameter or `security_group_ids`. We recommend that you use `security_group_ids`.	sg-wz9a8g2mt6x5llu0****
platform `deprecated`	string	No	[This field is deprecated] Use the `image_type` parameter instead. The operating system distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore` Default value: `AliyunLinux`.	null
instance_patterns	array	No	The instance attribute configuration.
	instance_patterns	No	The instance attributes.
ram_role_name	string	No	The Worker RAM role name. If left empty, the default Worker RAM role created by the cluster is used. If specified, the RAM role must be a normal service role with its trusted service configured as Elastic Compute Service. For more information, see Create a normal service role. When the specified RAM role is not the default Worker RAM role created by the cluster, the role name cannot start with `KubernetesMasterRole-` or `KubernetesWorkerRole-`. Important Only ACK managed clusters of version 1.22 or later support this parameter.	example-role
instance_metadata_options	InstanceMetadataOptions	No	The ECS instance metadata access configuration.
resource_pool_options	object	No	The resource pool and resource pool strategy used when creating instances. Note the following when you set this parameter: This parameter takes effect only when creating pay-as-you-go instances. This parameter cannot be set together with private_pool_options.match_criteria or private_pool_options.id.
strategy	string	No	Resource pool policy used when creating instances. Resource pools include private pools generated after Elasticity Assurance or Capacity Reservation takes effect, and public pools, for instance startup selection. Valid values: PrivatePoolFirst: private pool first. When this policy is selected and resouce_pool_options.private_pool_ids is specified, the specified private pools are used first. If no private pool is specified or the specified private pool capacity is insufficient, open-type private pools are automatically matched. If no eligible private pool is available, public pools are used to create instances. PrivatePoolOnly: private pool only. When this policy is selected, resouce_pool_options.private_pool_ids must be specified. If the specified private pool capacity is insufficient, instance creation fails. None: do not use resource pool policy. Default value: None.	PrivatePoolFirst
private_pool_ids	array	No	List of private pool IDs, i.e., Elasticity Assurance IDs or Capacity Reservation IDs. Only Target mode private pool IDs can be passed. Valid values of N: 1 to 20.
	string	No	Private pool ID, i.e., the Elasticity Assurance ID or Capacity Reservation ID. Only Target mode private pool IDs can be passed.	eap-bp67acfmxazb4****
system_disk_snapshot_policy_id	string	No	The system cloud disk snapshot policy.	sp-0jl6xnmme8v7o935****
disk_init	array	No	The block device initialization configuration.
	DiskInit	No	The DiskInit configuration.
node_config	object	No	The node configuration.
kubelet_configuration	kubelet_config	No	The Kubelet parameter settings.
kubernetes_config	object	No	The cluster-related configuration.
labels	array	No	The node labels. Adds labels to Kubernetes cluster nodes.
	tag	No	The label configuration.
taints	array	No	The taint configuration.
	taint	No	The taint configuration set.
runtime	string	No	The container runtime name. ACK supports the following three container runtimes: containerd: Recommended. Supports all cluster versions. Sandboxed-Container.runv: Sandboxed container that provides higher isolation. Supports cluster versions 1.31 and earlier. docker: No longer maintained. Supports cluster versions 1.22 and earlier. Default value: containerd.	containerd
runtime_version	string	No	The container runtime version.	1.6.38
cpu_policy	string	No	The node CPU management policy. The following two policies are supported for cluster versions 1.12.6 and later: `static`: Allows enhanced CPU affinity and exclusivity for pods with certain resource characteristics on the node. `none`: Enables the existing default CPU affinity scheme. Default value: `none`.	none
user_data	string	No	The instance user data. After the node joins the cluster, the specified instance user data script runs. For more information, see User-Data scripts.	dGhpcyBpcyBhIGV4YW1wbGU=
unschedulable	boolean	No	Specifies whether the scaled-out nodes are unschedulable. true: Unschedulable. false: Schedulable.	true
cms_enabled	boolean	No	Specifies whether to install CloudMonitor on ECS nodes. After installation, you can view monitoring information for the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values: `true`: Installs CloudMonitor on ECS nodes. `false`: Does not install CloudMonitor on ECS nodes. Default value: `false`.	false
node_name_mode	string	No	The custom node name. After you customize the node name, the node name, ECS instance name, and ECS instance hostname are all changed. Note For Windows instances with custom node names enabled, the hostname is fixed to the IP address with hyphens (-) replacing the dots (.) in the IP address, without prefix or suffix. The node name consists of a prefix, the node IP address, and a suffix: The total length is 2 to 64 characters. The node name must start and end with a lowercase letter or digit. The prefix and suffix can contain uppercase and lowercase letters, digits, hyphens (-), and periods (.). They must start with an uppercase or lowercase letter and cannot start or end with a hyphen (-) or period (.). Consecutive hyphens (-) or periods (.) are not allowed. The prefix is required (ECS restriction). The suffix is optional. The node IP is the full private IP address of the node. For example, if the node IP address is 192.XX.YY.55, the prefix is aliyun.com, and the suffix is test: For Linux nodes, the node name, ECS instance name, and ECS instance hostname are all aliyun.com192.XX.YY.55test. For Windows nodes, the ECS instance hostname is 192-XX-YY-55, and the node name and ECS instance name are both aliyun.com192.XX.YY.55test.	aliyun.com192.XX.YY.55test
pre_user_data	string	No	The instance pre-custom data. Before the node joins the cluster, the specified pre-custom data script runs. For more information, see User-Data scripts.	dGhpcyBpcyBhIGV4YW1wbGU
tee_config	object	No	The confidential computing cluster configuration.
tee_enable	boolean	No	Specifies whether to enable confidential computing for the cluster. true: Enables confidential computing. false: Does not enable confidential computing.	true
interconnect_config `deprecated`	object	No	[This field is deprecated] The edge node pool configuration.
cen_id	string	No	[This field is deprecated] The Cloud Enterprise Network (CEN) instance ID bound to the enhanced edge node pool.	null
ccn_id	string	No	[This field is deprecated] The Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool.	null
ccn_region_id	string	No	[This field is deprecated] The region of the Cloud Connect Network instance bound to the enhanced edge node pool.	null
bandwidth	integer	No	[This field is deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbps.	null
improved_period	string	No	[This field is deprecated] The purchase duration of the enhanced edge node pool. Unit: months.	null
count `deprecated`	integer	No	[This field is deprecated] Use desired_size instead. The number of nodes in the node pool.	null
max_nodes `deprecated`	integer	No	[This field is deprecated] The maximum number of nodes allowed in the edge node pool.	null
interconnect_mode	string	No	The network type of the edge node pool. This parameter takes effect only for node pools with `type` set to `edge`. Valid values: `basic`: Public network. Nodes in cloud node pool interact with cloud nodes over the public network. Applications in cloud node pool cannot directly access the cloud VPC internal network. `private`: Private network. Nodes in cloud node pool connect to the cloud through Express Connect, VPN, or CEN, providing higher cloud-edge communication quality and more effective security.	basic
host_network	boolean	No	Specifies whether the pod network mode uses host network mode. `true`: Host network. Pods directly use the host network stack and share the IP address and ports with the host. `false`: Container network. Pods have independent network stacks and do not occupy host network ports.	true
intranet	boolean	No	Specifies whether nodes in the edge node pool have Layer 3 network connectivity with each other. `true`: Connected. All nodes in this node pool have Layer 3 network connectivity with each other. `false`: Not connected. All nodes in this node pool do not have Layer 3 network connectivity with each other.	true
eflo_node_group	object	No	The Lingjun node pool configuration.
cluster_id	string	No	The Lingjun cluster ID to associate when creating a Lingjun node pool.	i1169130516633730****
group_id	string	No	The Lingjun group ID of the Lingjun cluster to associate when creating a Lingjun node pool.	ng-ec3c96ff0aa****
auto_attach_enabled	boolean	No
worker_ram_role_name	string	No
auto_mode	object	No	The node pool intelligent managed configuration.
enable	boolean	No	Specifies whether to enable intelligent managed mode. Valid values: true: Enables intelligent managed mode. This can be enabled only when the cluster has intelligent managed mode enabled. false: Does not enable intelligent managed mode.	true
node_components	array<object>	No	The list of node components.
	array<object>	No	The node component.
name	string	No	The node component name.	kubelet
version	string	No	The node component version.	1.33.3-aliyun.1
config	object	No	The node component configuration.
custom_config	object	No	Node component custom configuration.	{"cpuManagerPolicy":"static"}
	any	No	Node component custom configuration string.	cpuManagerPolicy

Response elements

Element	Type	Description	Example
	object	The node pool configuration.
nodepool_id	string	The node pool ID.	np31da1b38983f4511b490fc62108a****
task_id	string	The task ID.	T-613b19bbd160ad492800****
request_id	string	The request ID.	0527ac9a-c899-4341-a21a-****

Examples

Success response

JSON format

{
  "nodepool_id": "np31da1b38983f4511b490fc62108a****",
  "task_id": "T-613b19bbd160ad492800****",
  "request_id": "0527ac9a-c899-4341-a21a-****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.