Call the CreateClusterNodePool API to create a node pool - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

A node pool is a logical collection of a group of nodes with the same attributes, allowing unified management and O&M of nodes, such as node upgrades and auto scaling. You can further leverage 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	Cluster ID.	c61da77e8bfbc4c4c999af2b51b65****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request body parameters.
nodepool_info	object	No	Node pool configuration.
name	string	Yes	Node pool name.	nodepool-test
type	string	No	Node pool type. Valid values: `ess`: standard node pool (includes managed features and auto scaling capabilities). `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	Resource group ID of the node pool. Instances created by the node pool will belong to this resource group. A resource can only belong to one resource group. Depending on business scenarios, you can map resource groups to concepts such as projects, applications, or organizations.	rg-acfmyvw3wjmb****
auto_scaling	object	No	Auto scaling configuration.
enable	boolean	No	Whether to enable auto scaling. Valid values: `true`: enables the node pool auto scaling feature. When the cluster capacity planning cannot meet application Pod scheduling needs, ACK automatically scales node resources based on the configured minimum and maximum instance counts. Clusters of version 1.24 and later enable instant node scaling by default; clusters of versions earlier than 1.24 enable node auto scaling by default. For more information, see Node Scaling. `false`: disables auto scaling. ACK adjusts the number of nodes in the node pool based on the configured desired node count, always maintaining the node count at the desired number. When set to false, other configuration parameters within `auto_scaling` will not take effect. Default value: `false`.	false
type	string	No	Auto scaling instance type. Only takes effect when `enable=true`. Valid values: `cpu`: standard instance type. `gpu`: GPU instance type. `gpushare`: GPU sharing type. `spot`: preemptible instance type. Default value: `cpu`. Important This field cannot be modified after the node pool is created. Valid values: spot : Preemptible instance type cpu : Standard instance type gpushare : GPU sharing type gpu : GPU instance type	cpu
max_instances	integer	No	Maximum number of scalable instances in the node pool, excluding your existing instances. Only takes effect when `enable=true`. Valid values: [min_instances, 2000]. Default value: 0.	10
min_instances	integer	No	Minimum number of scalable instances in the node pool, excluding your existing instances. Only takes effect when `enable=true`. Valid values: [0, max_instances]. Default value: 0. Note When the minimum instance count is not 0, the corresponding number of ECS instances will be automatically created after the scaling group takes effect. We recommend that you set the maximum instance count to no less than the current number of nodes in the node pool. Otherwise, the auto scaling feature will directly cause the node pool to scale in.	1
is_bond_eip `deprecated`	boolean	No	[Deprecated] This field is deprecated. Use internet_charge_type and internet_max_bandwidth_out instead. Whether to bind an EIP. Valid values: `true`: bind an EIP. `false`: do not bind an EIP. Default value: `false`.	null
eip_internet_charge_type `deprecated`	string	No	[Deprecated] Use internet_charge_type and internet_max_bandwidth_out instead. EIP billing type. Valid values: `PayByBandwidth`: pay by fixed bandwidth. `PayByTraffic`: pay by traffic usage. Default value: `PayByBandwidth`.	null
eip_bandwidth `deprecated`	integer	No	[Deprecated] Use internet_charge_type and internet_max_bandwidth_out instead. EIP peak bandwidth. Unit: Mbps.	null
management	object	No	Node pool managed feature configuration.
enable	boolean	No	Whether to enable the managed feature of the node pool. Valid values: `true`: enable the managed feature. `false`: disable the managed feature. Other related configurations only take effect when enable=true. Default value: false.	false
auto_repair	boolean	No	Whether to automatically repair nodes. Only takes effect when `enable=true`. `true`: enable auto repair. `false`: disable auto repair. Default value: `true`.	true
auto_repair_policy	object	No	Auto repair node policy.
restart_node	boolean	No	Specifies whether to allow node restarts. This parameter takes effect only when `auto_repair=true`. Valid values: `true`: allows node restarts. `false`: does not allow node restarts. Default value: `true`.	true
approval_required	boolean	No	Specifies whether manual approval is required for node repair.
auto_vul_fix	boolean	No	Whether to automatically fix CVE vulnerabilities. Only takes effect when `enable=true`. `true`: allow automatic CVE fixes. `false`: do not allow automatic CVE fixes. Default value: `true`.	true
auto_vul_fix_policy	object	No	Auto CVE fix policy.
restart_node	boolean	No	Specifies whether to allow node restarts. This parameter takes effect only when `auto_vul_fix=true`. Valid values: `true`: allows node restarts. `false`: does not allow node restarts. Default value: `true`.	false
vul_level	string	No	The vulnerability levels that are allowed for automatic fixes, separated by commas. Example: `asap,later`. Supported vulnerability levels: `asap`: high `later`: medium `nntf`: low Default value: `asap`.	asap,nntf
exclude_packages	string	No	The packages to exclude during vulnerability fixes. Default value: `kernel`.	kernel
auto_upgrade	boolean	No	Whether to automatically upgrade nodes. Only takes effect when `enable=true`. `true`: enable auto upgrade. `false`: disable auto upgrade. Default value: `true`.	true
auto_upgrade_policy	object	No	Auto upgrade node policy.
auto_upgrade_kubelet	boolean	No	Specifies whether to allow automatic kubelet upgrades. This parameter takes effect only when `auto_upgrade=true`. Valid values: `true`: allows automatic kubelet upgrades. `false`: does not allow automatic kubelet upgrades. Default value: `true`.	true
auto_upgrade_runtime	boolean	No	Specifies whether to allow automatic runtime upgrades. This parameter takes effect only when `auto_upgrade=true`. Valid values: `true`: allows automatic runtime upgrades. `false`: does not allow automatic runtime upgrades. Default value: `true`.	false
auto_upgrade_os	boolean	No	Specifies whether to allow automatic operating system upgrades. This parameter takes effect only when `auto_upgrade=true`. Valid values: `true`: allows automatic operating system upgrades. `false`: does not allow automatic operating system upgrades. Default value: `false`.	false
upgrade_config `deprecated`	object	No	[Deprecated] Use the parent-level `auto_upgrade` parameter instead. Auto upgrade configuration. Only takes effect when `enable=true`.
auto_upgrade `deprecated`	boolean	No	[This parameter is deprecated] Use the `auto_upgrade` parameter at the upper level instead. Specifies whether to enable automatic upgrades. Valid values: `true`: enables automatic upgrades. `false`: disables automatic upgrades.	null
surge	integer	No	The number of extra nodes. You can specify either this parameter or `surge_percentage`. Nodes become unavailable during upgrades. You can create extra nodes to compensate for the cluster workload. Note The number of extra nodes should not exceed the current number of nodes.	0
surge_percentage	integer	No	The percentage of extra nodes. You can specify either this parameter or `surge`. Number of extra nodes = Extra node percentage × Number of nodes. For example, if the extra node percentage is set to 50% and there are 6 existing nodes, the number of extra nodes = 50% × 6 = 3.	0
max_unavailable	integer	No	The maximum number of unavailable nodes. Valid values: [1,1000]. Default value: 1.	1
auto_fault_diagnosis	boolean	No
scaling_group	object	No	Node pool scaling group configuration.
vswitch_ids	array	Yes	List of VSwitch IDs. Valid values: [1,8]. Note To ensure high availability, we recommend that you select VSwitches in different zones.
	string	No	VSwitch ID.	vsw-wz9mfnhmssud6eicu****
instance_types	array	Yes	List of node instance types for the node pool. When the node pool scales out nodes, it selects eligible instance types from the specified list. Supported instance type count range: [1,10]. Note To ensure high availability, we recommend that you select multiple instance types.
	string	No	Instance type. For more information, see Instance families.	ecs.d1ne.2xlarge
instance_charge_type	string	Yes	Billing type of node pool nodes. Valid values: `PrePaid`: subscription instance. `PostPaid`: pay-as-you-go instance. Default value: `PostPaid`. Valid values: PostPaid : Pay-as-you-go instance PrePaid : Subscription instance	PostPaid
period	integer	No	Subscription duration of node pool nodes. Only takes effect and is required when `instance_charge_type` is set to `PrePaid`. When `period_unit=Week`, valid values for `period`: {1, 2, 3, 4}. When `period_unit=Month`, valid values for `period`: {1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60}.	1
period_unit	string	No	Billing period unit of node pool nodes. Only takes effect and is required when `instance_charge_type` is set to `PrePaid`. `Month`: billed by month. `Week`: billed by week. Default value: `Month`.	Month
auto_renew	boolean	No	Whether to enable auto-renewal for node pool nodes. Only takes effect when `instance_charge_type` is set to `PrePaid`. Valid values: `true`: enable auto-renewal. `false`: disable auto-renewal. Default value: `false`.	true
auto_renew_period	integer	No	Duration for each auto-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	Preemptible instance type. Valid values: `NoSpot`: non-preemptible instance. `SpotWithPriceLimit`: set a maximum price for preemptible instances. `SpotAsPriceGo`: system automatically bids at the current market price. For more information, see Preemptible instances.	NoSpot
spot_price_limit	array<object>	No	Market price range configuration for a single preemptible instance type.
	object	No	Market price range configuration for preemptible instances. You can set different price ranges for different instance types.
instance_type	string	No	The spot instance type.	ecs.c6.large
price_limit	string	No	The maximum price per instance. Unit: USD/hour..	0.39
image_type	string	No	Operating system image type. Valid values: `AliyunLinux`: Alinux2 image. `AliyunLinuxSecurity`: Alinux2 image UEFI edition. `AliyunLinux3`: Alinux3 image. `AliyunLinux3Arm64`: Alinux3 image ARM edition. `AliyunLinux3Security`: Alinux3 image UEFI edition. `CentOS`: CentOS image. `Windows`: Windows image. `WindowsCore`: WindowsCore image. `ContainerOS`: container-optimized image. `AliyunLinux3ContainerOptimized`: Alinux3 container-optimized image.	AliyunLinux3
image_id	string	No	Custom image ID. The system-provided image is used by default.	aliyun_2_1903_x64_20G_alibase_20200529.vhd
system_disk_category	string	No	Node system disk type. Valid values: `cloud_efficiency`: ultra disk. `cloud_ssd`: SSD disk. `cloud_essd`: ESSD disk. `cloud_auto`: ESSD AutoPL disk. `cloud_essd_entry`: ESSD Entry disk. Default value: `cloud_efficiency`.	cloud_efficiency
system_disk_categories	array	No	Multiple disk types for the system disk. When a higher-priority disk type is unavailable, the system automatically tries the next priority disk type to create the system disk.
	string	No	Multiple system disk types for nodes. Valid values: `cloud`: basic disk. `cloud_efficiency`: ultra disk. `cloud_ssd`: SSD disk. `cloud_essd`: ESSD disk. `cloud_auto`: ESSD AutoPL disk. `cloud_essd_entry`: ESSD Entry disk.	cloud_essd
system_disk_size	integer	No	Node system disk size. Unit: GiB. Valid values: [20,2048].	120
system_disk_performance_level	string	No	Node system disk performance. Only takes effect for ESSD disks. The disk performance level is related to the disk size. For more information, see ESSD disks. PL0: moderate concurrent peak I/O performance with relatively stable read/write latency. PL1: moderate concurrent peak I/O performance with relatively stable read/write latency. PL2: high concurrent peak I/O performance with stable read/write latency. PL3: ultra-high concurrent peak I/O performance with extremely stable read/write latency.	PL1
system_disk_encrypted	boolean	No	Whether to encrypt the system disk. Valid values: true: encrypt. false: do not encrypt.	false
system_disk_kms_key_id	string	No	KMS key ID used by the system disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	No	Encryption algorithm used by the system disk. Valid values: aes-256.	aes-256
system_disk_bursting_enabled	boolean	No	Whether to enable burst (performance bursting) for the node system disk. Valid values: true: enable. false: disable. This parameter can only be set when `system_disk_category` is set to `cloud_auto`. For more information, see ESSD AutoPL disks.	true
system_disk_provisioned_iops	integer	No	Pre-provisioned read/write IOPS for the node system disk. Possible values: 0~min{50,000, 1000capacity-baseline performance}. Baseline performance=min{1,800+50capacity, 50000}. This parameter can only be set when `system_disk_category` is set to `cloud_auto`. For more information, see ESSD AutoPL disks.	1000
data_disks	array	No	Data disk configuration for node pool nodes.
	data_disk	No	Data disk configuration.
disk_init	array	No	Block device initialization configuration.
	DiskInit	No	DiskInit configuration.
security_group_ids	array	No	List of security group IDs. Use either this or `security_group_id`. We recommend using `security_group_ids`. When both `security_group_id` and `security_group_ids` are specified, `security_group_ids` takes precedence.
	string	No	List of security group IDs. Use either this or `security_group_id`. We recommend using `security_group_ids`. When both `security_group_id` and `security_group_ids` are specified, `security_group_ids` takes precedence.	sg-wz9a8g2mt6x5ll******
key_pair	string	No	Key pair name for passwordless login. Use either this or `login_password`. Note If the node pool uses ContainerOS, only `key_pair` is supported.	np-key-name
login_password	string	No	SSH login password. Use either this 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	Whether the provisioned ECS instances use non-root user login. true: log in as a non-root user (ecs-user). false: log in as root.	true
cis_enabled `deprecated`	boolean	No	[Deprecated] Use the security_hardening_os parameter instead.	null
soc_enabled	boolean	No	Whether to enable classified protection hardening. This can only be enabled 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 Level 3 classified protection images.	false
security_hardening_os	boolean	No	Alibaba Cloud OS security hardening. Valid values: `true`: enable Alibaba Cloud OS security hardening. `false`: disable Alibaba Cloud OS security hardening. Default value: `false`.	false
internet_charge_type	string	No	Public IP billing type. Valid values: PayByBandwidth: pay by fixed bandwidth. PayByTraffic: pay by traffic usage.	PayByTraffic
internet_max_bandwidth_out	integer	No	Maximum outbound public bandwidth for node public IP. Unit: Mbps (Mega bit per second). Valid values: [1,100].	5
tags	array<object>	No	Add tags only to ECS instances. Tag keys cannot be duplicated and have a maximum length of 128 characters. Tag keys and tag values cannot start with "aliyun" or "acs:", or contain "https://" or "http://".
	object	No	Node labels.
key	string	No	The tag key.	node-k-1
value	string	No	The tag value.	node-v-1
desired_size	integer	No	Desired node count for the node pool. The total number of nodes that the node pool should maintain. We recommend configuring at least 2 nodes to ensure cluster components run properly. You can scale the node pool out or in by adjusting the desired node count. If no nodes need to be created, set this to 0 and manually adjust later to increase the node count.	0
multi_az_policy	string	No	Multi-zone scaling group ECS instance scaling policy. 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 next-priority VSwitch is automatically used. `COST_OPTIMIZED`: attempts to create instances in order of vCPU unit price from lowest to highest. When the scaling configuration has multiple instance types with preemptible billing, preemptible instances are preferentially created. You can use the `CompensateWithOnDemand` parameter to specify whether to automatically try creating pay-as-you-go instances when preemptible instances cannot be created due to inventory or other reasons. Note `COST_OPTIMIZED` only takes effect when the scaling configuration has multiple instance types or uses preemptible instances. `BALANCE`: evenly distributes ECS instances across multiple zones specified by the scaling group. If zones become unbalanced due to insufficient inventory or other reasons, you can use the RebalanceInstances API to rebalance resources. Default value: `PRIORITY`.	COST_OPTIMIZED
scaling_policy	string	No	Scaling group mode. Valid values: `release`: standard mode. Scales by creating and releasing ECS instances based on resource usage. `recycle`: rapid mode. Scales by creating, stopping, and starting ECS instances, improving the speed of subsequent scaling (compute resources are not charged during stop, only storage fees apply, except for local disk instance types). Default value: `release`.	release
on_demand_base_capacity	integer	No	Minimum number of pay-as-you-go instances required by the scaling group. Valid values: [0,1000]. When the number of pay-as-you-go instances is less than this value, pay-as-you-go instances are preferentially created.	0
on_demand_percentage_above_base_capacity	integer	No	After the scaling group meets the minimum pay-as-you-go instance count (`on_demand_base_capacity`) requirement, the percentage of pay-as-you-go instances among the excess instances. Valid values: [0,100].	20
spot_instance_pools	integer	No	Number of available instance types specified. The scaling group will evenly create preemptible instances using the lowest-cost instance types. Valid values: [1,10].	5
spot_instance_remedy	boolean	No	Whether to enable preemptible instance supplementation. When enabled, the scaling group will attempt to create new instances to replace preemptible instances that are about to be reclaimed when the reclamation notification is received. Valid values: `true`: enable preemptible instance supplementation. `false`: disable preemptible instance supplementation.	false
compensate_with_on_demand	boolean	No	When `multi_az_policy` is set to `COST_OPTIMIZED`, whether to allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement when sufficient preemptible instances cannot be created due to price, inventory, or other reasons. Valid values: `true`: allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement. `false`: do not allow automatically creating pay-as-you-go instances to meet the ECS instance count requirement.	true
deploymentset_id	string	No	Deployment set ID. You can use a deployment set to distribute ECS instances created by the node pool across different physical servers to ensure business high availability and underlying disaster recovery capabilities. When creating ECS instances within a deployment set, the instances are distributed across the specified region based on the pre-configured deployment strategy. Important After selecting a deployment set, the maximum number of nodes in the node pool will be limited. The default node limit supported by a deployment set is 20 * number of zones (the number of zones is determined by the VSwitches). Choose carefully to ensure sufficient quota within the deployment set to avoid node provisioning failures.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	No	List of RDS instances.
	string	No	RDS instance ID.	rds-****
private_pool_options	object	No	Private pool configuration.
id	string	No	The private pool ID. When `match_criteria` is set to `Target`, you must specify the private pool ID.	eap-bp67acfmxazb4****
match_criteria	string	No	The private pool type. Specifies the capacity option for the private pool used to launch instances. After an elasticity assurance or capacity reservation takes effect, a private pool is generated for instance launches. Valid values: `Open`: open mode. Automatically matches open-type private pool capacity. If no matching private pool capacity is available, public pool resources are used to launch instances. `Target`: targeted mode. Uses the specified private pool capacity to launch instances. If the specified private pool capacity is unavailable, the instance fails to launch. `None`: none mode. Private pool capacity is not used to launch instances.	Target
security_group_id `deprecated`	string	No	Node pool security group ID. Use either this or `security_group_ids`. We recommend using `security_group_ids`.	sg-wz9a8g2mt6x5llu0****
platform `deprecated`	string	No	[Deprecated] Use the `image_type` parameter instead. Operating system distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore` Default value: `AliyunLinux`.	null
instance_patterns	array	No	Instance attribute configuration.
	instance_patterns	No	Instance attributes.
ram_role_name	string	No	Worker RAM role name. When empty, the default Worker RAM role created by the cluster is used. When not empty, the specified RAM role must be a normal service role, and its trusted service must be 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 This parameter is only supported for ACK managed clusters of version 1.22 and later.	example-role
instance_metadata_options	InstanceMetadataOptions	No	ECS instance metadata access configuration.
resource_pool_options	object	No	Resource pool and resource pool strategy used when creating instances. Note the following when setting this parameter: This parameter only takes effect when creating pay-as-you-go instances. This parameter cannot be set simultaneously with private_pool_options.match_criteria or private_pool_options.id.
strategy	string	No	The resource pool policy used when creating instances. Resource pools include private pools generated by elasticity assurance or capacity reservation services and public pools. 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 pools are specified or the specified private pool capacity is insufficient, open-type private pools are automatically matched. If no matching private pools are available, public pool resources are used to create instances. PrivatePoolOnly: private pool only. When this policy is selected, you must specify resouce_pool_options.private_pool_ids. If the specified private pool capacity is insufficient, the instance fails to launch. None: no resource pool policy is used. Default value: None.	PrivatePoolFirst
private_pool_ids	array	No	The list of private pool IDs, which are elasticity assurance IDs or capacity reservation IDs. Only Target-mode private pool IDs can be specified. Valid values of N: 1 to 20.
	string	No	The private pool ID, which is an elasticity assurance ID or capacity reservation ID. Only Target-mode private pool IDs can be specified.	eap-bp67acfmxazb4****
system_disk_snapshot_policy_id	string	No	System disk snapshot policy.	sp-0jl6xnmme8v7o935****
node_config	object	No	Node configuration.
kubelet_configuration	kubelet_config	No	Kubelet parameter configuration.
kubernetes_config	object	No	Cluster-related configuration.
labels	array	No	Node labels. Add labels to Kubernetes cluster nodes.
	tag	No	Label configuration.
taints	array	No	Taint configuration.
	taint	No	Collection of taint configurations.
runtime	string	No	Container runtime name. ACK supports the following three container runtimes: containerd: recommended, supports all cluster versions. Sandboxed-Container.runv: secure sandbox container, provides higher isolation, supports clusters of version 1.31 and earlier. docker: discontinued maintenance, supports clusters of version 1.22 and earlier. Default value: containerd.	containerd
runtime_version	string	No	Container runtime version.	1.6.38
cpu_policy	string	No	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	Instance custom data. After the node joins the cluster, the specified instance custom data script will be executed. For more information, see User-Data scripts.	dGhpcyBpcyBhIGV4YW1wbGU=
unschedulable	boolean	No	Whether nodes after scale-out are unschedulable. true: unschedulable. false: schedulable.	true
cms_enabled	boolean	No	Whether to install CloudMonitor on ECS nodes. After installation, you can view monitoring information of the created ECS instances in the CloudMonitor console. We recommend enabling this. Valid values: `true`: install CloudMonitor on ECS nodes. `false`: do not install CloudMonitor on ECS nodes. Default value: `false`.	false
node_name_mode	string	No	Custom node name. After customizing the node name, the node name, ECS instance name, and ECS instance hostname will all be changed. Note For Windows instances with custom node names enabled, the hostname is fixed to the IP address with - replacing . in the IP address, without prefix or suffix. The node name consists of three parts: prefix, node IP address, and suffix: Total length is 2-64 characters. The node name must start and end with lowercase letters or digits. The prefix and suffix can contain uppercase and lowercase letters, digits, hyphens (-), and periods (.). Must start with a letter, cannot start or end with a hyphen (-) or period (.). Consecutive hyphens (-) or periods (.) are not allowed. Prefix is required (ECS restriction), suffix is optional. Node IP is the complete 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	Instance pre-custom data. Before the node joins the cluster, the specified instance pre-custom data script will be executed. For more information, see User-Data scripts.	dGhpcyBpcyBhIGV4YW1wbGU
tee_config	object	No	Trusted execution environment (TEE) cluster configuration.
tee_enable	boolean	No	Whether to enable TEE cluster. true: enable TEE. false: disable TEE.	true
interconnect_config `deprecated`	object	No	[Deprecated] Edge node pool configuration.
cen_id	string	No	[Deprecated] Cloud Enterprise Network (CEN) instance ID bound to the enhanced edge node pool (CENID).	null
ccn_id	string	No	[Deprecated] Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool (CCNID).	null
ccn_region_id	string	No	[Deprecated] Region of the Cloud Connect Network (CCN) instance bound to the enhanced edge node pool.	null
bandwidth	integer	No	[Deprecated] Network bandwidth of the enhanced edge node pool. Unit: Mbps.	null
improved_period	string	No	[Deprecated] Purchase duration of the enhanced edge node pool. Unit: months.	null
count `deprecated`	integer	No	[Deprecated] Use desired_size instead. Number of nodes in the node pool.	null
max_nodes `deprecated`	integer	No	[Deprecated] Maximum number of nodes allowed in the edge node pool.	null
interconnect_mode	string	No	Network type of the edge node pool. This parameter only takes effect for `edge`-type node pools. Valid values: `basic`: public network. Nodes in the node pool interact with cloud nodes through the public network, and applications in the node pool cannot directly access the cloud VPC internal network. `private`: private network. Nodes in the node pool connect cloud and on-premises networks through leased lines, VPN, or CEN, providing higher cloud-edge communication quality and more effective security.	basic
host_network	boolean	No	Whether the Pod network mode uses host network mode. `true`: host network. Pods directly use the host network stack, sharing the IP address and ports with the host. `false`: container network. Pods have their own independent network stack and do not occupy host network ports.	true
intranet	boolean	No	Whether nodes in the edge node pool are interconnected at Layer 3. `true`: interconnected. All nodes in this node pool are interconnected at Layer 3. `false`: not interconnected. All hosts in this node pool are not interconnected at Layer 3.	true
eflo_node_group	object	No	Lingjun node pool configuration.
cluster_id	string	No	Lingjun cluster ID to associate when creating a Lingjun node pool.	i1169130516633730****
group_id	string	No	Lingjun group ID of the Lingjun cluster to associate when creating a Lingjun node pool.	ng-ec3c96ff0aa****
auto_mode	object	No	Node pool intelligent managed configuration.
enable	boolean	No	Whether to enable intelligent managed mode. Valid values: true: enable intelligent managed mode. Can only be enabled when the cluster has intelligent managed mode enabled. false: disable intelligent managed mode.	true
node_components	array<object>	No	List of node components.
	array<object>	No	Node component.
name	string	No	Node component name.	kubelet
version	string	No	Node component version.	1.33.3-aliyun.1
config	object	No	Node component configuration.
custom_config	object	No	The custom configuration of the node component.	{"cpuManagerPolicy":"static"}
	string	No	Custom configuration string for the node component.	cpuManagerPolicy

Response elements

Element	Type	Description	Example
	object	Node pool configuration.
nodepool_id	string	Node pool ID.	np31da1b38983f4511b490fc62108a****
task_id	string	Task ID.	T-613b19bbd160ad492800****
request_id	string	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.