Use DescribeClusterNodePoolDetail to query node pool details - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

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 node pool details.
nodepool_info	object	The node pool configuration.
nodepool_id	string	The node pool ID.	np615c0e0966124216a0412e10afe0****
name	string	The node pool name.	default-nodepool
type	string	The node pool type. Valid values: `ess`: standard node pool (includes managed and elastic scaling features). `edge`: edge node pool. `lingjun`: Lingjun node pool.	ess
is_default	boolean	Indicates whether this is the default node pool. Typically, a cluster has only one default node pool. Valid values: `true`: Default node pool. `false`: Non-default node pool.	true
resource_group_id	string	The resource group ID.	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 last updated.	2025-04-15T15:39:45.41+08:00
status	object	The node pool status.
state	string	The node pool status. Valid values: `active`: Active. `scaling`: Scaling. `removing`: Removing nodes. `deleting`: Deleting. `updating`: Updating.	active
healthy_nodes	integer	The number of healthy nodes.	3
initial_nodes	integer	The number of nodes 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 being removed.	0
serving_nodes	integer	The number of serving nodes.	3
total_nodes	integer	The total number of nodes in the node pool.	3
conditions	array<object>	The node pool conditions, which represent the status information of the node pool across different dimensions.
	object	A single status attribute.
type	string	The type.	ImageUpgradeReady
status	string	The status.	True
reason	string	The reason.	UpgradeDisabled
message	string	The detailed information.	AutoUpgradeDisabled
last_transition_time	string	The time of the last status transition.	20--30T10:39:00+08:00
auto_scaling	object	The auto scaling configuration for the node pool.
enable	boolean	Specifies whether to enable elastic scaling. Valid values: `true`: Enables the elastic scaling feature for the node pool. When the cluster capacity planning cannot meet application pod scheduling requirements, ACK automatically scales node resources based on the configured minimum and maximum instance counts. Clusters of version 1.24 or later use instant node elasticity by default. Clusters of versions earlier than 1.24 use node elastic scaling by default. For more information, see Node scaling. `false`: Disables elastic 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.	true
type	string	The auto scaling type, categorized by instance type. Valid values: `cpu`: regular instance type. `gpu`: GPU instance type. `gpushare`: GPU sharing type. `spot`: spot instance type.	cpu
max_instances	integer	The maximum number of instances that can be scaled in the node pool, excluding your existing instances.	10
min_instances	integer	The minimum number of instances that can be scaled in the node pool, excluding your existing instances.	1
eip_internet_charge_type	string	The EIP billing type. Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-traffic.	PayByBandwidth
is_bond_eip	boolean	Specifies whether to associate an EIP. Valid values: `true`: Associate an EIP. `false`: Do not associate an EIP.	true
eip_bandwidth	integer	The peak bandwidth of the EIP. Valid values: [1,100]. Unit: Mbit/s.	5
management	object	The managed node pool configuration.
enable	boolean	Specifies whether to enable the managed node pool. Valid values: `true`: Enable the managed node pool. `false`: Disable the managed node pool. Other related configurations take effect only when `enable=true`.	true
auto_repair	boolean	Specifies whether to enable auto repair. This parameter takes effect only when `enable=true`. Valid values: `true`: Enable auto repair. `false`: Disable auto repair.	true
auto_repair_policy	object	The auto repair node policy.
restart_node	boolean	Specifies whether to allow node restarts. This parameter takes effect only when `auto_repair=true`. Valid values: `true`: Allow node restarts. `false`: Do not allow node restarts.	true
approval_required	boolean	Specifies 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 of parallel repairs. When a large number of abnormal nodes exist in the node pool, this specifies the maximum number or percentage of nodes that can be repaired simultaneously.	1
max_unhealthy_nodes_threshold	string	The self-healing circuit breaker condition. When the number or percentage of faulty nodes exceeds this threshold, self-healing enters circuit breaker state and stops initiating new repair actions.	10%
auto_vul_fix	boolean	Specifies whether to automatically fix CVEs. This takes effect only when `enable=true`. `true`: Allows automatic CVE fixes. `false`: Does not allow automatic CVE fixes.	true
auto_vul_fix_policy	object	The auto CVE fix policy.
restart_node	boolean	Specifies whether to allow node restarts. This takes effect only when `auto_vul_fix=true`. Valid values: `true`: Allows node restarts. `false`: Does not allow node restarts.	true
vul_level	string	The vulnerability levels that are allowed for automatic fixes, separated by commas. `asap`: high `later`: medium `nntf`: low	asap,nntf
exclude_packages	string	The packages that should be excluded during vulnerability fixes.	kernel
auto_upgrade	boolean	Specifies whether to automatically upgrade nodes. This takes effect only when `enable=true`. `true`: Enables auto upgrade. `false`: Does not enable auto upgrade.	true
auto_upgrade_policy	object	The auto upgrade policy.
auto_upgrade_kubelet	boolean	Specifies whether to allow automatic kubelet upgrades. This takes effect only when `auto_upgrade=true`. Valid values: `true`: Allows automatic kubelet upgrades. `false`: Does not allow automatic kubelet upgrades.	true
upgrade_config	object	The auto upgrade configuration. This takes effect only when `enable=true`.
auto_upgrade	boolean	Specifies whether to enable auto upgrade. Valid values: `true`: Enables auto upgrade. `false`: Does not enable auto upgrade.	true
surge	integer	The number of extra nodes. You can set this parameter or surge_percentage, but not both.	5
surge_percentage	integer	The percentage of extra nodes. You can set this parameter or `surge`, but not both. Number of extra nodes = Percentage of extra nodes × Number of nodes. For example, if the percentage of extra nodes is set to 50% and there are 6 existing nodes, the number of extra nodes = 50% × 6 = 3.	50
max_unavailable	integer	The maximum number of unavailable nodes. Valid values: [1,1000]. Default value: 1.	1
auto_fault_diagnosis	boolean	Specifies whether to enable ECS fault detection for node self-healing.
drift_enabled	boolean	Specifies whether to enable node rotation. Only intelligent managed node pools support this feature, and it is enabled by default. Common node pools do not support this feature.
scaling_group	object	The scaling group configuration of the node pool.
scaling_group_id	string	The scaling group ID.	asg-2zeieod8giqmov7z****
vswitch_ids	array	The list of vSwitch IDs.
	string	The vSwitch ID.	vsw-2ze3ds0mdip0hdz8i****
instance_types	array	The list of node instance types.
	string	The node instance type.	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 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}.	0
period_unit	string	The billing period unit of nodes. This parameter must be specified when `instance_charge_type` is set to `PrePaid`. `Month`: measured in months. `Week`: measured in weeks.	Month
auto_renew	boolean	Specifies whether to enable auto-renewal for nodes. This takes effect only when `instance_charge_type` is set to `PrePaid`. Valid values: `true`: Enables auto-renewal. `false`: Does not enable auto-renewal.	false
auto_renew_period	integer	The duration of each auto-renewal cycle. Valid values: PeriodUnit=Week: 1, 2, 3. PeriodUnit=Month: 1, 2, 3, 6, 12, 24, 36, 48, 60.	1
spot_strategy	string	The type of spot instance. 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>	The price range configurations for spot instances.
	object	The price range configuration for spot instances. You can set different price ranges for different instance types.
instance_type	string	The spot instance type.	ecs.c6.large
price_limit	string	The market price of a single instance. Unit: USD/hour.	0.39
image_type	string	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	The custom image ID.	aliyun_3_x64_20G_alibase_20241218.vhd
system_disk_category	string	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.	cloud_efficiency
system_disk_categories	array	The multiple disk types for the system cloud disk. When a higher-priority disk type is unavailable, the system automatically attempts the next-priority disk type to create the system cloud disk.
	string	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.	cloud_essd
system_disk_size	integer	The size of the node system cloud disk, in GiB. Valid values: [20,2048].	120
system_disk_performance_level	string	The performance level of the node system cloud disk. This applies only to ESSD cloud disks. The performance level is related to the disk size. For more information, see ESSD cloud disks. Valid values: 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	Specifies whether to encrypt the system cloud disk. Valid values: `true`: Encrypted. `false`: Not encrypted.	false
system_disk_kms_key_id	string	The KMS key ID used by the system cloud disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	The encryption algorithm used by the system cloud disk. Valid values: aes-256.	aes-256
system_disk_bursting_enabled	boolean	Indicates whether burst (performance burst) is enabled for the node system cloud disk. Valid values: true: Enabled. When enabled, the cloud disk temporarily improves performance during sudden data read/write pressure from fluctuating workloads until the workload returns to a steady state. false: Not enabled. This parameter is supported only when `system_disk_category` is set to `cloud_auto`. For more information, see ESSD AutoPL cloud disk.	true
system_disk_provisioned_iops	integer	The provisioned read/write IOPS for the node system cloud disk. Possible values: 0~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 disk.	1000
data_disks	array	The combination of data cloud disk type, size, and other configurations for nodes.
	data_disk	The node data cloud disk configuration.
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 key pair name, mutually exclusive with `login_password`. When the node pool is a managed node pool, only `key_pair` is supported.	pro-nodepool
login_password	string	The SSH logon password, mutually exclusive with `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 purposes, the password returned in the query result is encrypted.	********
login_as_non_root	boolean	Indicates whether the provisioned ECS instance uses a non-root user for logon. true: Logs on as a non-root user (ecs-user). false: Logs on as the root user.	true
cis_enabled `deprecated`	boolean	[Deprecated] Use the security_hardening_os parameter instead.	false
soc_enabled	boolean	Indicates whether MLPS 2.0 security hardening is enabled. This can be enabled 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 Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3 MLPS 2.0 Level 3 images.	false
security_hardening_os	boolean	Specifies whether Alibaba Cloud OS security hardening is enabled. Valid values: `true`: Alibaba Cloud OS security hardening is enabled. `false`: Alibaba Cloud OS security hardening is not enabled. Default value: `false`.	false
internet_charge_type	string	The billing method for the node public IP. Valid values: PayByBandwidth: billed by fixed bandwidth. PayByTraffic: billed by traffic usage.	PayByBandwidth
internet_max_bandwidth_out	integer	The maximum outbound bandwidth for the node public IP, in Mbps (Mega bit per second). Valid values: 1 to 100.	10
tags	array	The ECS instance tags.
	tag	The node tag.
desired_size	integer	The desired number of nodes in the node pool.	2
multi_az_policy	string	The multi-zone scaling policy for ECS instances in the scaling group. Valid values: `PRIORITY`: Scales based on the vSwitches (VSwitchIds.N) you define. When ECS instances cannot be created in the zone of the highest-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 sets multiple instance types with preemptible billing, spot instances are created first. You can use the `CompensateWithOnDemand` parameter to specify whether 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 sets multiple instance types or uses spot instances. `BALANCE`: Allocates ECS instances evenly 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. For more information, see RebalanceInstances. Default value: `PRIORITY`. Settings: Billable methods for the scaling group depend on the selected policy.	BALANCE
scaling_policy	string	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 (compute resources are not charged during stop, only storage fees apply, except for local disk instance types).	release
on_demand_base_capacity	integer	The minimum number of pay-as-you-go instances required by the scaling group. Valid values: [0,1000]. Pay-as-you-go instances are created first when the count is below this value.	0
on_demand_percentage_above_base_capacity	integer	The percentage of pay-as-you-go instances among instances that exceed the minimum on-demand base capacity (`on_demand_base_capacity`). Valid values: [0,100].	20
spot_instance_pools	integer	The number of available instance types. The scaling group creates spot instances evenly across the lowest-cost types. Valid values: [1,10].	5
spot_instance_remedy	boolean	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`: Does not enable supplementing spot instances.	false
compensate_with_on_demand	boolean	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 when 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
enable_high_density_mode	boolean	Indicates whether high-density cloud disk mode is enabled. This is supported only when the node pool uses instance types. When enabled, the total number of system and data cloud disks does not exceed the high-density cloud disk limit supported by the instance type.	false
deploymentset_id	string	The deployment set ID.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	If an RDS instance list is specified, the ECS nodes in the cluster are automatically added to the RDS access whitelist.
	string	The RDS instance.	rm-xxx
private_pool_options	object	The private node pool configuration.
id	string	The private node pool ID.	eap-bp67acfmxazb4****
match_criteria	string	The private node pool type. Specifies the private pool capacity option for instance launch. After an elasticity assurance or capacity reservation takes effect, a private pool capacity is generated for instance launch. 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 for launch. `Target`: Specified mode. Uses the specified private pool capacity to launch instances. If the specified private pool capacity is unavailable, the instance fails to launch. `None`: Do not use mode. The instance launch does not use private pool capacity.	Open
security_group_id	string	The security group ID of the node pool. When the node pool is associated with multiple security groups, this 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 ram_role_name instead.	KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****
instance_patterns	array	The instance attribute configurations.
	instance_patterns	The instance attributes.
ram_role_name	string	The Worker RAM role name.	KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****
instance_metadata_options	InstanceMetadataOptions	The metadata access configuration for ECS instances.
resource_pool_options	object	The resource pool and resource pool policy 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 snapshot policy for the system cloud disk.	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 node tag.
	tag	The ECS tag.
taints	array	The node taint information. Taints and tolerations work together to prevent pods from being scheduled to inappropriate nodes. For more information, see taint-and-toleration.
	taint	The node taint configuration.
runtime	string	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.	containerd
runtime_version	string	The container runtime version.	1.6.38
cpu_policy	string	The node CPU management policy. The following two policies are supported for clusters running version 1.12.6 or later: `static`: Allows pods with certain resource characteristics on the node to be granted enhanced CPU affinity and exclusivity. `none`: Enables the existing default CPU affinity scheme.	none
user_data	string	The node pool custom data, which is a script that runs after node initialization. For more information, see Generate instance user data.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi
unschedulable	boolean	Specifies whether scaled-out nodes are unschedulable. true: Unschedulable. false: Schedulable.	true
cms_enabled	boolean	Specifies whether to install the CloudMonitor agent 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 the CloudMonitor agent on ECS nodes. `false`: Does 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 ".". Each part can contain lowercase letters, digits, and hyphens (-). The node name must start and end with a lowercase letter or digit. The IP address segment length specifies the number of digits taken 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 prefix is aliyun.com, the IP address segment length is 5, and the suffix is test, the node name is aliyun.com00055test.	aliyun.com192.XX.YY.55test
pre_user_data	string	The node pool pre-custom data, which is a script that runs 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 confidential computing for the cluster. Valid values: `true`: Enabled. `false`: Not enabled.	false
interconnect_config	object	[Deprecated] The network-related configuration for edge node pools. This value is only meaningful for node pools of the edge type.
cen_id	string	[Deprecated] The Cloud Enterprise Network (CEN) instance ID bound to the edge enhanced node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[Deprecated] The Cloud Connect Network (CCN) instance ID bound to the edge enhanced node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[Deprecated] The region of the Cloud Connect Network (CCN) instance bound to the edge enhanced node pool.	cn-shanghai
bandwidth	integer	[Deprecated] The network bandwidth of the edge enhanced node pool. Unit: Mbps.	10
improved_period	string	[Deprecated] The purchase duration of the edge enhanced 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 for node pools with `type` set to `edge`. Valid values: `basic`: Public network. Nodes in cloud node pool interact with cloud nodes over the Internet. 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	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	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
auto_mode	object	The intelligent managed 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 node component name.	kubelet
version	string	The node component version.	1.33.3-aliyun.1
config	object	The node component configuration.
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	Indicates whether automatic addition 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.