DescribeClusterNodePoolDetail-阿里云帮助中心

Queries the configuration of a specified node pool in a cluster by node pool ID.

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:DescribeClusterNodePoolDetail

get

*Cluster

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c23421cfa74454bc8b37163fd19af****
NodepoolId	string	Yes	The node pool ID.	np31da1b38983f4511b490fc62108a****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
nodepool_info	object	The node pool configurations.
nodepool_id	string	The node pool ID.	np615c0e0966124216a0412e10afe0****
name	string	The name of the node pool.	default-nodepool
type	string	The type of the node pool. Valid values: `ess`: standard node pool, which includes managed and automatic elastic scaling features. `edge`: edge node pool. `lingjun`: Lingjun node pool.	ess
is_default	boolean	Indicates whether the node pool is the default node pool. Typically, a cluster has only one default node pool. Valid values: `true`: The node pool is the default node pool. `false`: The node pool is not the default node pool.	true
resource_group_id	string	The ID of the resource group.	rg-acfmyvw3wjmb****
region_id	string	The region ID.	cn-beijing
created	string	The time when the node pool was created.	2025-04-10T14:25:37.285530433+08:00
updated	string	The time when the node pool was updated.	2025-04-15T15:39:45.41+08:00
status	object	The status of the node pool.
state	string	The state of the node pool. Valid values: `active`: The node pool is active. `scaling`: The node pool is scaling. `removing`: Nodes are being removed from the node pool. `deleting`: The node pool is being deleted. `updating`: The node pool is being updated.	active
healthy_nodes	integer	The number of healthy nodes.	3
initial_nodes	integer	The number of nodes that are being created.	0
failed_nodes	integer	The number of failed nodes.	0
offline_nodes	integer	The number of offline nodes.	0
removing_nodes	integer	The number of nodes that are being removed.	0
serving_nodes	integer	The number of working nodes.	3
total_nodes	integer	The total number of nodes in the node pool.	3
conditions	array<object>	The current conditions of the node pool, which indicate the status information of the node pool across different dimensions.
	object	A single condition attribute.
type	string	The type of the condition.	ImageUpgradeReady
status	string	The status of the condition.	True
reason	string	The reason for the condition.	UpgradeDisabled
message	string	The detailed information about the condition.	AutoUpgradeDisabled
last_transition_time	string	The time of the last status transition. The time is in the ISO 8601 format and includes time zone information.	20--30T10:39:00+08:00
auto_scaling	object	The auto scaling configurations of the node pool.
enable	boolean	Indicates whether auto scaling is enabled. Valid values: `true`: Auto scaling is enabled for the node pool. When the capacity planning of the cluster cannot meet the scheduling requirements of application pods, ACK automatically scales node resources based on the configured minimum and maximum numbers of instances. For clusters of Kubernetes 1.24 and later, just-in-time elasticity is enabled by default. For clusters earlier than Kubernetes 1.24, auto scaling is enabled by default. For more information, see Node scaling. `false`: Auto scaling is disabled. ACK adjusts the number of nodes in the node pool based on the configured expected number of nodes to keep the number of nodes at the expected value. If this parameter is set to `false`, other configuration parameters in auto_scaling do not take effect.	true
type	string	The auto scaling type, which is classified by the type of auto scaling instances. Valid values: `cpu`: standard instance. `gpu`: GPU-accelerated instance. `gpushare`: shared GPU-accelerated instance. `spot`: spot instance.	cpu
max_instances	integer	The maximum number of scalable instances in the node pool, excluding existing instances.	10
min_instances	integer	The minimum number of scalable instances in the node pool, excluding existing instances.	1
eip_internet_charge_type	string	The billing method of the elastic IP address (EIP). Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-data-transfer.	PayByBandwidth
is_bond_eip	boolean	Indicates whether an EIP is bound. Valid values: `true`: An EIP is bound. `false`: No EIP is bound.	true
eip_bandwidth	integer	The peak bandwidth of the EIP. Valid values: 1 to 100. Unit: Mbit/s.	5
management	object	The configurations of the managed node pool.
enable	boolean	Indicates whether the managed node pool is enabled. Valid values: `true`: The managed node pool is enabled. `false`: The managed node pool is disabled. Other related configurations take effect only when enable is set to `true`.	true
auto_repair	boolean	Indicates whether auto repair is enabled. This parameter takes effect only when enable is set to `true`. Valid values: `true`: Auto repair is enabled. `false`: Auto repair is disabled.	true
auto_repair_policy	object	The auto repair policy for nodes.
restart_node	boolean	Indicates whether nodes can be restarted. This parameter takes effect only when auto_repair is set to `true`. Valid values: `true`: Nodes can be restarted. `false`: Nodes cannot be restarted.	true
approval_required	boolean	Indicates whether manual approval is required for node repair.	false
auto_repair_policy_id	string	The ID of the auto-repair policy.	r-xxxxxxxxxx
max_parallel_repairing_nodes	string	The maximum number or percentage of nodes that can be repaired simultaneously when a large number of abnormal nodes exist in the node pool.	1
max_unhealthy_nodes_threshold	string	The circuit breaker threshold for auto-repair. When the number or percentage of faulty nodes exceeds this threshold, auto-repair enters the circuit breaker state and stops initiating new repair actions.	10%
auto_vul_fix	boolean	Specifies whether to automatically repair CVEs. This parameter takes effect only when `enable` is set to `true`. Valid values: `true`: Automatically repairs CVEs. `false`: Does not automatically repair CVEs.	true
auto_vul_fix_policy	object	The policy for automatically repairing CVEs.
restart_node	boolean	Specifies whether to allow node restarts. This parameter takes effect only when `auto_vul_fix` is set to `true`. Valid values: `true`: Allows node restarts. `false`: Does not allow node restarts.	true
vul_level	string	The vulnerability levels that are allowed for auto-repair, separated by commas. Valid values: `asap`: High. `later`: Medium. `nntf`: Low.	asap,nntf
exclude_packages	string	The packages to be excluded during vulnerability repair.	kernel
auto_upgrade	boolean	Specifies whether to automatically upgrade nodes. This parameter takes effect only when `enable` is set to `true`. Valid values: `true`: Enables auto-upgrade. `false`: Disables auto-upgrade.	true
auto_upgrade_policy	object	The policy for automatic upgrades.
auto_upgrade_kubelet	boolean	Specifies whether to allow automatic kubelet upgrades. This parameter takes effect only when `auto_upgrade` is set to `true`. Valid values: `true`: Allows automatic kubelet upgrades. `false`: Does not allow automatic kubelet upgrades.	true
upgrade_config	object	The configuration for automatic upgrades. This parameter takes effect only when `enable` is set to `true`.
auto_upgrade	boolean	Specifies whether to enable automatic upgrades. Valid values: `true`: Enables automatic upgrades. `false`: Disables automatic upgrades.	true
surge	integer	The number of surge nodes. This parameter and `surge_percentage` are mutually exclusive.	5
surge_percentage	integer	The percentage of surge nodes. This parameter and `surge` are mutually exclusive. The number of surge nodes is calculated by multiplying the surge node percentage by the total number of nodes. For example, if the surge node percentage is set to 50% and the total number of nodes is 6, the number of surge nodes generated is 50% × 6 = 3.	50
max_unavailable	integer	The maximum number of unavailable nodes. Valid values: 1 to 1000. Default value: 1.	1
auto_fault_diagnosis	boolean	Specifies whether to enable ECS fault detection for node auto-repair.
drift_enabled	boolean	Specifies whether to enable node rotation. This feature is supported only by intelligent managed node pools and is enabled by default. It is not supported by regular node pools.
scaling_group	object	The scaling group configuration of the node pool.
scaling_group_id	string	The ID of the scaling group.	asg-2zeieod8giqmov7z****
vswitch_ids	array	The list of vSwitch IDs.
	string	The vSwitch ID.	vsw-2ze3ds0mdip0hdz8i****
instance_types	array	The list of instance types for nodes.
	string	The instance type of the node.	ecs.n4.large
instance_charge_type	string	The billing method of nodes in the node pool. Valid values: `PrePaid`: Subscription. `PostPaid`: Pay-as-you-go.	PostPaid
period	integer	The subscription duration of nodes. This parameter is required and takes effect only when `instance_charge_type` is set to `PrePaid`. Valid values: When `period_unit` is set to `Week`, valid values are 1, 2, 3, and 4. When `period_unit` is set to `Month`, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.	0
period_unit	string	The billing period of nodes. This parameter is required when `instance_charge_type` is set to `PrePaid`. Valid values: `Month`: Uses the month as the time unit. `Week`: Uses the week as the time unit.	Month
auto_renew	boolean	Specifies whether to enable auto-renewal for nodes. This parameter takes effect only when `instance_charge_type` is set to `PrePaid`. Valid values: `true`: Enables auto-renewal. `false`: Disables auto-renewal.	false
auto_renew_period	integer	The auto-renewal period. Valid values: When PeriodUnit is set to Week: 1, 2, and 3. When PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60.	1
spot_strategy	string	The bidding strategy for spot instances. Valid values: `NoSpot`: Regular pay-as-you-go instances. `SpotWithPriceLimit`: Sets a maximum price for spot instances. `SpotAsPriceGo`: Uses the current market price automatically. For more information, see Spot instances.	NoSpot
spot_price_limit	array<object>	The market price range configuration for spot instances.
	object	The market price range configuration for spot instances. You can set different price ranges for different instance types.
instance_type	string	The instance type of the spot instance.	ecs.c6.large
price_limit	string	The market price per instance. Unit: CNY/hour.	0.39
image_type	string	The type of the operating system image. Valid values: `AliyunLinux`: Alinux 2 image. `AliyunLinuxSecurity`: Alinux 2 UEFI image. `AliyunLinux3`: Alinux 3 image. `AliyunLinux3Arm64`: Alinux 3 ARM image. `AliyunLinux3Security`: Alinux 3 UEFI image. `CentOS`: CentOS image. `Windows`: Windows image. `WindowsCore`: Windows Core image. `ContainerOS`: Container-optimized image. `AliyunLinux3ContainerOptimized`: Alinux 3 container-optimized image.	AliyunLinux3
image_id	string	The ID of the custom image.	aliyun_3_x64_20G_alibase_20241218.vhd
system_disk_category	string	The category of the 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.	cloud_efficiency
system_disk_categories	array	The categories of the system cloud disk. If a high-priority disk category is unavailable, the system automatically attempts to use the next priority disk category to create the system cloud disk.
	string	The category of the 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.	cloud_essd
system_disk_size	integer	The size of the system cloud disk. Unit: GiB. Valid values: 20 to 2048.	120
system_disk_performance_level	string	The performance level of the system cloud disk. This parameter takes effect only for ESSDs. The performance level is related to the disk size. For more information, see ESSD. Valid values: `PL0`: Medium concurrent I/O performance and relatively stable read/write latency. `PL1`: Medium concurrent I/O performance and relatively stable read/write latency. `PL2`: High concurrent I/O performance and stable read/write latency. `PL3`: Ultra-high concurrent I/O performance and ultra-stable read/write latency.	PL1
system_disk_encrypted	boolean	Specifies whether to encrypt the system cloud disk. Valid values: `true`: Encrypts the system cloud disk. `false`: Does not encrypt the system cloud disk.	false
system_disk_kms_key_id	string	The KMS key ID used for the system cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	The encryption algorithm used for the system cloud disk. Valid values: aes-256.	aes-256
system_disk_bursting_enabled	boolean	Specifies whether to enable burst mode for the system cloud disk of the node. This parameter is configured when the disk type is cloud_auto. Valid values: true: Enabled. After this feature is enabled, if the workload faces sudden data read and write pressure, the cloud disk temporarily improves its performance based on the actual workload conditions until the workload returns to a stable state. 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	The provisioned read and write IOPS for the system cloud disk of the node. 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	The combination of configurations such as the type and size of the data cloud disks for the node.
	data_disk	The data cloud disk configuration of the node.
security_group_ids	array	The list of security group IDs for the node pool.
	string	The security group ID of the node pool.	sg-2ze60ockeekspl3d****
key_pair	string	The name of the key pair. You must specify either this parameter or login_password. If the node pool is a managed node pool, only key_pair is supported.	pro-nodepool
login_password	string	The SSH logon password. You must 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. For security reasons, the password in the query result is encrypted.	********
login_as_non_root	boolean	Specifies whether to log on to the created ECS instance as a non-root user. Valid values: true: Log on as a non-root user (ecs-user). false: Log on as the root user.	true
cis_enabled `deprecated`	boolean	[Deprecated] Use the security_hardening_os parameter instead.	false
soc_enabled	boolean	Specifies whether to enable MLPS 2.0 security hardening. You can enable this feature for nodes 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 the Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3 MLPS 2.0 Level 3 images.	false
security_hardening_os	boolean	Specifies whether to enable Alibaba Cloud OS security hardening. Valid values: true: Enable Alibaba Cloud OS security hardening. false: Do not enable Alibaba Cloud OS security hardening. Default value: false.	false
internet_charge_type	string	The billing method for the public IP address of the node. Valid values: PayByBandwidth: Pay-by-bandwidth. PayByTraffic: Pay-by-traffic.	PayByBandwidth
internet_max_bandwidth_out	integer	The maximum outbound bandwidth for the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.	10
tags	array	The labels of the ECS instance.
	tag	The tag of the node.
desired_size	integer	The expected number of nodes in the node pool.	2
multi_az_policy	string	The scaling policy for ECS instances in a multi-zone scaling group. Valid values: PRIORITY: Scale based on the vSwitches (VSwitchIds.N) that you specify. If ECS instances cannot be created in the zone of the vSwitch with the highest priority, the system automatically uses the vSwitch with the next highest priority to create ECS instances. COST_OPTIMIZED: Create instances based on the vCPU unit price in ascending order. If the scaling configuration specifies multiple instance types that use the spot billing method, the system preferentially creates spot instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances if spot instances cannot be created due to insufficient inventory or other reasons. Note The COST_OPTIMIZED value takes effect only when the scaling configuration specifies multiple instance types or uses spot instances. BALANCE: Evenly allocate ECS instances across the zones specified in the scaling group. If the instances are unevenly distributed across zones due to insufficient inventory or other reasons, you can call the RebalanceInstances operation to balance the resources. For more information, see RebalanceInstances. Default value: PRIORITY.	BALANCE
scaling_policy	string	The pattern of the scaling group. Valid values: release: Standard pattern. The scaling group scales by creating and releasing ECS instances based on the requested resource usage. recycle: Swift pattern. The scaling group scales by creating, stopping, and starting instances to improve the speed of subsequent scaling operations. When an instance is stopped, you are not charged for compute resources, but you are still charged for storage resources, except for instances with local disks.	release
on_demand_base_capacity	integer	The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than this value, the system preferentially creates pay-as-you-go instances.	0
on_demand_percentage_above_base_capacity	integer	The percentage of pay-as-you-go instances among the excess instances after the scaling group meets the minimum number of pay-as-you-go instances (on_demand_base_capacity). Valid values: 0 to 100.	20
spot_instance_pools	integer	The number of available instance types specified. The scaling group evenly creates spot instances based on the most cost-effective instance types. Valid values: 1 to 10.	5
spot_instance_remedy	boolean	Specifies whether to enable spot instance replenishment. After this feature is enabled, if the scaling group receives a system message indicating that a spot instance will be reclaimed, the scaling group attempts to create a new instance to replace the spot instance to be reclaimed. Valid values: true: Enable spot instance replenishment. false: Disable spot instance replenishment.	false
compensate_with_on_demand	boolean	Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances if sufficient spot instances cannot be created due to price or inventory reasons when multi_az_policy is set to COST_OPTIMIZED. Valid values: true: Allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances. false: Do not allow automatic creation of pay-as-you-go instances to meet the required number of ECS instances.	true
enable_high_density_mode	boolean	Specifies whether to enable high-density cloud disk mode. This feature is supported only when the node pool uses instance types. After this feature is enabled, the total number of system cloud disks and data cloud disks does not exceed the maximum number of high-density cloud disks supported by the instance type.	false
deploymentset_id	string	The ID of the deployment set.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	If ApsaraDB RDS instances are specified, the ECS instances of the cluster nodes are automatically added to the whitelist of the ApsaraDB RDS instances.
	string	The ApsaraDB RDS instance.	rm-xxx
private_pool_options	object	The private node pool configurations.
id	string	The ID of the private node pool.	eap-bp67acfmxazb4****
match_criteria	string	The type of the private node pool and the private pool capacity matching criteria for instance startup. After the elasticity assurance or capacity reservation takes effect, private pool capacity is generated for you to select when you start instances. Valid values: Open: Open mode. The system automatically matches the capacity of open private pools. If no eligible private pool capacity is available, the system uses public pool resources to start the instance. In this mode, you do not need to specify the PrivatePoolOptions.Id parameter. Target: Target mode. The system uses the specified private pool capacity to start the instance. If the specified private pool capacity is unavailable, the instance fails to start. In this mode, you must specify the private pool ID, which means the PrivatePoolOptions.Id parameter is required. None: None mode. The system does not use private pool capacity to start the instance.	Open
security_group_id	string	The security group ID of the node pool. If multiple security groups are bound to the node pool, this value is the first value in security_group_ids.	sg-2ze60ockeekspl3d****
platform	string	The operating system distribution. Valid values: CentOS AliyunLinux Windows WindowsCore	AliyunLinux
ram_policy	string	[Deprecated] Use the ram_role_name parameter instead.	KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****
instance_patterns	array	The instance property configurations.
	instance_patterns	The instance property.
ram_role_name	string	The name of the worker RAM role.	KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****
instance_metadata_options	InstanceMetadataOptions	The metadata access configurations of the ECS instance.
resource_pool_options	object	The resource pool and resource pool policies used when creating instances.
private_pool_ids	array	The list of private pool IDs.
	string	The private pool ID.	eap-bp1c1fohub5jccwi****
strategy	string	The resource pool strategy used when creating instances. Valid values: PrivatePoolFirst: Private pool first. PrivatePoolOnly: Private pool only. None: No resource pool strategy is used.	PrivatePoolFirst
system_disk_snapshot_policy_id	string	The system cloud disk snapshot policy.	sp-bp11g8z59rawcud9****
disk_init	array	The block device initialization configuration.
	DiskInit	The DiskInit configuration.
cpu_options	object	The CPU-related configuration options.
nested_virtualization	string	Specifies whether nested virtualization is enabled. Valid values: disabled: Nested virtualization is disabled. enabled: Nested virtualization is enabled.	enabled
node_config	object	The node configuration.
kubelet_configuration	kubelet_config	The Kubelet parameter settings.
node_os_config	object	The node operating system configuration.
hugepage	Hugepage	The Hugepage configuration.
kubernetes_config	object	The cluster-related configuration.
labels	array	The tag of the node.
	tag	The ECS tag.
taints	array	The node taint information. Taints and tolerations work together to prevent pods from being scheduled onto inappropriate nodes. For more information, see Taints and Tolerations.
	taint	The node taint configuration.
runtime	string	The name of the container runtime. ACK supports the following three container runtimes: containerd: Recommended. Supported by all cluster versions. Sandboxed-Container.runv: Sandboxed container. Provides higher isolation. Supported by clusters of version 1.31 and earlier. docker: Deprecated. Supported by clusters of version 1.22 and earlier.	containerd
runtime_version	string	The container runtime version.	1.6.38
cpu_policy	string	The CPU management policy for nodes. The following two policies are supported when the cluster version is 1.12.6 or later: static: Allows pods with specific resource characteristics on the node to have enhanced CPU affinity and exclusivity. none: Indicates that the existing default CPU affinity scheme is used.	none
user_data	string	The custom data for the node pool, which refers to the scripts that run after node initialization. For more information, see Generate instance user data.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi
unschedulable	boolean	Specifies whether the scaled-out nodes are unschedulable. Valid values: true: Unschedulable. false: Schedulable.	true
cms_enabled	boolean	Specifies whether to install the CloudMonitor agent on ECS nodes. After installation, you can view the monitoring information of the created ECS instances in the CloudMonitor console. Recommended. Valid values: true: Install the CloudMonitor agent on ECS nodes. false: Do not install the CloudMonitor agent on ECS nodes.	true
node_name_mode	string	The custom node name. A node name consists of three parts: prefix + node IP address substring + suffix. The prefix and suffix can each consist of one or more parts separated by periods (.). Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or a digit. The IP address substring length refers to the number of digits truncated from the end of the node IP address. Valid values: 5 to 12. For example, if the node IP address is 192.168.0.55, the specified prefix is aliyun.com, the IP address substring length is 5, and the suffix is test, the node name is aliyun.com00055test.	aliyun.com192.XX.YY.55test
pre_user_data	string	The pre-custom data for the node pool, which refers to the scripts that run before node initialization. For more information, see Generate instance user data.	dGhpcyBpcyBhIGV4YW1wbGU
tee_config	object	The confidential computing cluster configuration.
tee_enable	boolean	Specifies whether to enable the confidential computing cluster. Valid values: true: Enabled. false: Disabled.	false
interconnect_config	object	[Deprecated] The network configuration for edge node pools. This value is valid only for node pools of the edge type.
cen_id	string	[Deprecated] The instance ID of the Cloud Enterprise Network (CEN) attached to the edge-optimized node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[Deprecated] The instance ID of the Cloud Connect Network (CCN) attached to the edge-optimized node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[Deprecated] The region of the CCN instance bound to the edge-optimized node pool.	cn-shanghai
bandwidth	integer	[Deprecated] The network bandwidth of the edge-optimized node pool. Unit: Mbit/s.	10
improved_period	string	[Deprecated] The subscription duration of the edge-optimized node pool. Unit: months.	1
max_nodes	integer	[Deprecated] The maximum number of nodes allowed in the edge node pool.	10
interconnect_mode	string	The network type of the edge node pool. This parameter takes effect only when type is 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 internal network of the cloud VPC. private: Private network. Nodes in cloud node pool connect on-premises and cloud networks through Express Connect circuits, VPNs, or CEN. This provides higher cloud-edge communication quality and more effective security protection.	basic
host_network	boolean	Specifies whether the pod network uses the host network mode. Valid values: true: Host network. Pods directly use the network stack of the host 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	Specifies whether Layer 3 network connectivity is enabled among nodes in the edge node pool. Valid values: true: Connected. Layer 3 network connectivity is enabled among all nodes in the node pool. false: Disconnected. Layer 3 network connectivity is disabled among all hosts in the node pool.	true
auto_mode	object	The intelligent management configuration.
enable	boolean	Specifies whether intelligent management is enabled.	false
node_components	array<object>	The list of node components.
	array<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.	{"cpuManagerPolicy":"static"}
	any	The custom configuration string of the node component.	cpuManagerPolicy
envs	array<object>	The environment variables of the node component.
	object
name	string	The name of the environment variable.	LOG_LEVEL
value	string	The value of the environment variable.	info
config_revision	string	The version number of the custom configuration for the node component.	1
eflo_node_group	object	The Lingjun node group information.
cluster_id	string	The ID of the Lingjun cluster.	i113790071760688002461
group_id	string	The ID of the Lingjun group.	i128147721760688002463
auto_attach_enabled	boolean	Specifies whether automatic attachment to the Lingjun node pool is enabled.
worker_ram_role_name	string	The worker RAM role used by the Lingjun node pool.

Examples

Success response

JSON format

{
  "nodepool_info": {
    "nodepool_id": "np615c0e0966124216a0412e10afe0****",
    "name": "default-nodepool",
    "type": "ess",
    "is_default": true,
    "resource_group_id": "rg-acfmyvw3wjmb****",
    "region_id": "cn-beijing",
    "created": "2025-04-10T14:25:37.285530433+08:00",
    "updated": "2025-04-15T15:39:45.41+08:00"
  },
  "status": {
    "state": "active",
    "healthy_nodes": 3,
    "initial_nodes": 0,
    "failed_nodes": 0,
    "offline_nodes": 0,
    "removing_nodes": 0,
    "serving_nodes": 3,
    "total_nodes": 3,
    "conditions": [
      {
        "type": "ImageUpgradeReady",
        "status": "True",
        "reason": "UpgradeDisabled",
        "message": "AutoUpgradeDisabled",
        "last_transition_time": "20**-**-30T10:39:00+08:00"
      }
    ]
  },
  "auto_scaling": {
    "enable": true,
    "type": "cpu",
    "max_instances": 10,
    "min_instances": 1,
    "eip_internet_charge_type": "PayByBandwidth",
    "is_bond_eip": true,
    "eip_bandwidth": 5
  },
  "management": {
    "enable": true,
    "auto_repair": true,
    "auto_repair_policy": {
      "restart_node": true,
      "approval_required": false,
      "auto_repair_policy_id": "r-xxxxxxxxxx",
      "max_parallel_repairing_nodes": "1",
      "max_unhealthy_nodes_threshold": "10%"
    },
    "auto_vul_fix": true,
    "auto_vul_fix_policy": {
      "restart_node": true,
      "vul_level": "asap,nntf",
      "exclude_packages": "kernel"
    },
    "auto_upgrade": true,
    "auto_upgrade_policy": {
      "auto_upgrade_kubelet": true
    },
    "upgrade_config": {
      "auto_upgrade": true,
      "surge": 5,
      "surge_percentage": 50,
      "max_unavailable": 1
    },
    "auto_fault_diagnosis": false,
    "drift_enabled": false
  },
  "scaling_group": {
    "scaling_group_id": "asg-2zeieod8giqmov7z****",
    "vswitch_ids": [
      "vsw-2ze3ds0mdip0hdz8i****"
    ],
    "instance_types": [
      "ecs.n4.large"
    ],
    "instance_charge_type": "PostPaid",
    "period": 0,
    "period_unit": "Month",
    "auto_renew": false,
    "auto_renew_period": 1,
    "spot_strategy": "NoSpot",
    "spot_price_limit": [
      {
        "instance_type": "ecs.c6.large",
        "price_limit": "0.39"
      }
    ],
    "image_type": "AliyunLinux3",
    "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
    "system_disk_category": "cloud_efficiency",
    "system_disk_categories": [
      "cloud_essd"
    ],
    "system_disk_size": 120,
    "system_disk_performance_level": "PL1",
    "system_disk_encrypted": false,
    "system_disk_kms_key_id": "0e478b7a-4262-4802-b8cb-00d3fb40****",
    "system_disk_encrypt_algorithm": "aes-256",
    "system_disk_bursting_enabled": true,
    "system_disk_provisioned_iops": 1000,
    "data_disks": [
      {
        "category": "cloud_ssd",
        "size": 40,
        "encrypted": "true",
        "kms_key_id": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "auto_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
        "performance_level": "PL1",
        "provisioned_iops": 1000,
        "bursting_enabled": true,
        "auto_format": true,
        "file_system": "ext4",
        "mount_target": "/mnt/path1",
        "disk_name": "DataDiskName",
        "device": "/dev/xvdb",
        "snapshot_id": "s-280s7****"
      }
    ],
    "security_group_ids": [
      "sg-2ze60ockeekspl3d****"
    ],
    "key_pair": "pro-nodepool",
    "login_password": "********",
    "login_as_non_root": true,
    "cis_enabled": false,
    "soc_enabled": false,
    "security_hardening_os": false,
    "internet_charge_type": "PayByBandwidth",
    "internet_max_bandwidth_out": 10,
    "tags": [
      {
        "key": "env",
        "value": "prod"
      }
    ],
    "desired_size": 2,
    "multi_az_policy": "BALANCE",
    "scaling_policy": "release",
    "on_demand_base_capacity": 0,
    "on_demand_percentage_above_base_capacity": 20,
    "spot_instance_pools": 5,
    "spot_instance_remedy": false,
    "compensate_with_on_demand": true,
    "enable_high_density_mode": false,
    "deploymentset_id": "ds-bp1d19mmbsv3jf6xxxxx",
    "rds_instances": [
      "rm-xxx"
    ],
    "private_pool_options": {
      "id": "eap-bp67acfmxazb4****",
      "match_criteria": "Open"
    },
    "security_group_id": "sg-2ze60ockeekspl3d****",
    "platform": "AliyunLinux",
    "ram_policy": "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****",
    "instance_patterns": [
      {
        "cores": 4,
        "memory": 8,
        "instance_family_level": "EnterpriseLevel",
        "excluded_instance_types": [
          "ecs.c6.large"
        ],
        "min_cpu_cores": 4,
        "max_cpu_cores": 8,
        "min_memory_size": 8,
        "max_memory_size": 16,
        "instance_categories": [
          "General-purpose"
        ],
        "cpu_architectures": [
          "X86"
        ],
        "core": 4,
        "max_price": 2,
        "architectures": [
          "X86"
        ],
        "burst_performance_option": "Exclude",
        "instance_type_families": [
          "ecs.c6"
        ],
        "minimum_eni_quantity": 3,
        "minimum_eni_private_ip_address_quantity": 10,
        "minimum_eni_ipv6_address_quantity": 1,
        "maximum_gpu_amount": 8
      }
    ],
    "ram_role_name": "KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****",
    "instance_metadata_options": {
      "http_tokens": "optional"
    },
    "resource_pool_options": {
      "private_pool_ids": [
        "eap-bp1c1fohub5jccwi****"
      ],
      "strategy": "PrivatePoolFirst"
    },
    "system_disk_snapshot_policy_id": "sp-bp11g8z59rawcud9****",
    "disk_init": [
      {
        "disk_name": "disk0",
        "mkfs_type": "ext4",
        "mount_target": "/mnt/disk0",
        "mount_for_runtime": false,
        "local_disk": false
      }
    ],
    "cpu_options": {
      "nested_virtualization": "enabled"
    }
  },
  "node_config": {
    "kubelet_configuration": {
      "registryPullQPS": 5,
      "registryBurst": 10,
      "eventRecordQPS": 5,
      "eventBurst": 10,
      "kubeAPIQPS": 5,
      "kubeAPIBurst": 10,
      "serializeImagePulls": true,
      "cpuManagerPolicy": "none",
      "evictionHard": {
        "test": "test",
        "test2": 1
      },
      "evictionSoft": {
        "test": "test",
        "test2": 1
      },
      "evictionSoftGracePeriod": {
        "test": "test",
        "test2": 1
      },
      "systemReserved": {
        "test": "test",
        "test2": 1
      },
      "kubeReserved": {
        "test": "test",
        "test2": 1
      },
      "readOnlyPort": 0,
      "maxPods": 110,
      "containerLogMaxSize": "10Mi",
      "containerLogMaxFiles": 5,
      "featureGates": {
        "test": "test",
        "test2": 1
      },
      "allowedUnsafeSysctls": [
        "net.core.somaxconn"
      ],
      "reservedMemory": [
        {
          "numaNode": 0,
          "limits": {
            "memory": "1Gi"
          }
        }
      ],
      "memoryManagerPolicy": "none",
      "cpuCFSQuota": true,
      "cpuCFSQuotaPeriod": "100ms",
      "imageGCHighThresholdPercent": 85,
      "imageGCLowThresholdPercent": 80,
      "podPidsLimit": -1,
      "topologyManagerPolicy": "restricted",
      "clusterDNS": [
        "127.0.xx.xx"
      ],
      "tracing": {
        "endpoint": "localhost:4317",
        "samplingRatePerMillion": 200000
      },
      "containerLogMaxWorkers": 1,
      "containerLogMonitorInterval": "10s",
      "serverTLSBootstrap": true
    },
    "node_os_config": {
      "hugepage": {
        "transparentEnabled": "",
        "transparentDefrag": "",
        "khugepagedDefrag": 0,
        "khugepagedAllocSleepMillisecs": 0,
        "khugepagedScanSleepMillisecs": 0,
        "khugepagedPagesToScan": 0
      }
    }
  },
  "kubernetes_config": {
    "labels": [
      {
        "key": "env",
        "value": "prod"
      }
    ],
    "taints": [
      {
        "key": "key",
        "value": "value",
        "effect": "NoSchedule"
      }
    ],
    "runtime": "containerd",
    "runtime_version": "1.6.38",
    "cpu_policy": "none",
    "user_data": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi",
    "unschedulable": true,
    "cms_enabled": true,
    "node_name_mode": "aliyun.com192.XX.YY.55test",
    "pre_user_data": "dGhpcyBpcyBhIGV4YW1wbGU\n"
  },
  "tee_config": {
    "tee_enable": false
  },
  "interconnect_config": {
    "cen_id": "cen-ey9k9nfhz0f*******",
    "ccn_id": "ccn-qm5i0i0q9yi*******",
    "ccn_region_id": "cn-shanghai",
    "bandwidth": 10,
    "improved_period": "1"
  },
  "max_nodes": 10,
  "interconnect_mode": "basic",
  "host_network": true,
  "intranet": true,
  "auto_mode": {
    "enable": false
  },
  "node_components": [
    {
      "name": "kubelet",
      "version": "1.33.3-aliyun.1",
      "config": {
        "custom_config": {
          "key": "cpuManagerPolicy"
        },
        "envs": [
          {
            "name": "LOG_LEVEL",
            "value": "info"
          }
        ]
      },
      "config_revision": "1"
    }
  ],
  "eflo_node_group": {
    "cluster_id": "i113790071760688002461",
    "group_id": "i128147721760688002463",
    "auto_attach_enabled": false,
    "worker_ram_role_name": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.