Use DescribeClusterNodePools to query all node pools in a cluster - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries all node pools in a cluster.

Operation description

When removing nodes, perform standardized operations through this API or the Container Service console. Do not manually remove nodes by using kubectl delete node.
Do not directly release nodes, remove instances, or allow nodes to be passively released due to subscription instance expiration in the ECS or ESS console (or through related APIs). In these cases, nodes are directly stopped and automatically removed from the Container Service console.
If the node pool has a desired node count configured, the node pool automatically scales out other instances based on the corresponding configuration to maintain the node count at the desired number.
Removing nodes involves Pod migration, which may affect your services. Perform this operation during off-peak hours. Unexpected risks may occur during the operation. Back up relevant data in advance.
When removing nodes, ACK executes a drain operation. Ensure that other nodes in the cluster have sufficient resources to avoid application Pods that cannot be scheduled.
Check the node affinity rules and scheduling policies of Pods on the nodes to be removed to ensure that Pods are not left unschedulable after node removal.

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

get

*Cluster

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
NodepoolName	string	No	The node pool name.	nodepool-test

Response elements

Element	Type	Description	Example
	object	The node pool details.
nodepools	array<object>	The list of node pool instances.
	array<object>	The node pool instance details.
nodepool_info	object	The node pool information.
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 features and elastic scaling). `edge`: edge node pool. `lingjun`: Lingjun node pool.	ess
is_default	boolean	Indicates whether this is the default node pool. A cluster typically 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-acfmyvw3wjm****
region_id	string	The region ID.	cn-beijing
created	string	The time when the node pool was created.	2025-04-15T16:33:29.362888807+08:00
updated	string	The time when the node pool was last updated.	2025-04-15T16:33:32.823+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 instances.	3
initial_nodes	integer	The number of nodes being created.	0
failed_nodes	integer	The number of failed instances.	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 nodes in the serving state.	3
total_nodes	integer	The total number of nodes in the node pool.	3
auto_scaling	object	The auto scaling configuration.
enable	boolean	Specifies whether auto scaling is enabled. Valid values: `true`: Enables the auto scaling feature for the node pool. When the cluster capacity planning cannot meet Pod scheduling requirements, ACK automatically scales node resources based on the configured minimum and maximum instance counts. Clusters of version 1.24 and later use instant node elasticity by default. Clusters earlier than version 1.24 use 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 and maintains the node count at the desired number. 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 scalable instances in the node pool, excluding your existing instances.	10
min_instances	integer	The minimum number of scalable instances in the node pool, excluding your existing instances.	2
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 EIP peak bandwidth. Valid values: [1,100]. Unit: Mbit/s.	5
management	object	The managed node pool configuration. This configuration takes effect only in professional managed clusters.
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`. `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 restart. This parameter takes effect only when `auto_repair=true`. `true`: Allow node restart. `false`: Do not allow node restart.	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-xxxxxxxxx
auto_vul_fix	boolean	Specifies whether to enable automatic CVE fix. This parameter takes effect only when `enable=true`. `true`: Enable automatic CVE fix. `false`: Disable automatic CVE fix.	true
auto_vul_fix_policy	object	The automatic CVE fix policy.
restart_node	boolean	Specifies whether to allow node restart. This parameter takes effect only when `auto_vul_fix=true`. Valid values: `true`: Allow node restart. `false`: Do not allow node restart.	true
vul_level	string	The vulnerability levels allowed for automatic fix, separated by commas. `asap`: high `later`: medium `nntf`: low	asap,nntf
exclude_packages	string	The packages to exclude during vulnerability fix.	kernel
auto_upgrade	boolean	Specifies whether to enable automatic node upgrade. This parameter takes effect only when `enable=true`. `true`: Enable auto upgrade. `false`: Disable auto upgrade.	true
auto_upgrade_policy	object	The auto upgrade policy.
auto_upgrade_kubelet	boolean	Specifies whether to allow automatic kubelet upgrade. This parameter takes effect only when `auto_upgrade=true`. Valid values: `true`: Allow automatic kubelet upgrade. `false`: Do not allow automatic kubelet upgrade.	true
upgrade_config	object	The auto upgrade configuration. This parameter takes effect only when `enable=true`.
auto_upgrade	boolean	Specifies whether to enable auto upgrade. Valid values: `true`: Enable auto upgrade. `false`: Disable auto upgrade.	true
surge	integer	The number of extra nodes. Mutually exclusive with `surge_percentage`.	5
surge_percentage	integer	The percentage of extra nodes. Mutually exclusive with `surge`. Extra nodes = extra node percentage × number of nodes. For example, if the extra node percentage is 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
scaling_group	object	The scaling group configuration of the node pool.
scaling_group_id	string	The scaling group ID.	asg-2ze8n5qw4atggut8****
vswitch_ids	array	The list of vSwitch IDs.
	string	The vSwitch ID.	vsw-2ze3ds0mdip0hdz8i****
instance_types	array	The list of node instance types. You can select multiple instance types as alternatives. During node creation, the system attempts to purchase instances starting from the first specification until successful. The final purchased instance type may vary depending on inventory availability.	ecs.n4.large
	string	The node instance type.	ecs.n4.large
instance_charge_type	string	The billing type 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}.	1
period_unit	string	The subscription period unit. This parameter must be specified when `instance_charge_type` is set to `PrePaid`. `Month`: month. `Week`: week.	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`: Enable auto-renewal. `false`: Disable auto-renewal.	false
auto_renew_period	integer	The duration of each auto-renewal cycle. Valid values: When PeriodUnit=Week: 1, 2, 3. When PeriodUnit=Month: 1, 2, 3, 6, 12, 24, 36, 48, 60.	0
spot_strategy	string	The spot instance type. 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 spot instance market price range configuration.
	object	The spot instance market price range configuration. 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 range per instance. Unit: USD/hour.	0.39
image_type	string	The operating system image type. `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. You can call `DescribeKubernetesVersionMetadata` to query the images supported by the system.	aliyun_3_x64_20G_alibase_20241218.vhd
system_disk_category	string	The node system cloud disk type. 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 system cloud disk types. 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 node system cloud disk type. 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.	EESSD云盘
system_disk_size	integer	The node system cloud disk size. Unit: GiB. Valid values: [20,2048].	120
system_disk_performance_level	string	The performance level of the node system cloud disk. This parameter takes effect only for ESSD disks. The performance level is related to the disk size. For more information, see ESSD cloud disks. PL0: moderate maximum concurrent I/O performance with relatively stable read/write latency. PL1: moderate maximum concurrent I/O performance with relatively stable read/write latency. PL2: high maximum concurrent I/O performance with stable read/write latency. PL3: ultra-high maximum concurrent I/O performance with extremely stable read/write latency.	PL1
system_disk_encrypted	boolean	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 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 (performance burst) for the node system cloud disk. Valid values: true: Enable. When enabled, the cloud disk temporarily boosts performance during sudden data read/write pressure until the workload returns to a steady state. false: Disable. 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/write IOPS for the node system cloud disk. Configure this parameter when the disk type is cloud_auto.	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.
disk_init	array	The block device initialization configuration.
	DiskInit	The DiskInit configuration.
security_group_ids	array	The list of security group IDs for the node pool.
	string	The list of security group IDs for the node pool.	sg-2ze1iuk12m2sb4c4****
key_pair	string	The key pair name. Mutually exclusive with `login_password`. For managed node pools, only `key_pair` is supported.	pro-nodepool
login_password	string	The SSH login password. Mutually exclusive with `key_pair`. Logon password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. For security purposes, logon password is encrypted in query results.	******
login_as_non_root	boolean	Specifies whether scaled-out ECS instances use non-root user login. true: Log on as a non-root user (ecs-user). false: Log on as the root user. [_single.resp.200.props.nodep	true
cis_enabled `deprecated`	boolean	[This field is deprecated] Use the security_hardening_os parameter instead.	false
soc_enabled	boolean	Specifies whether to enable MLPS 2.0 security hardening. You can enable MLPS 2.0 security hardening for nodes only when the system image is Alibaba Cloud Linux 2 or Alibaba Cloud Linux 3. Alibaba Cloud provides baseline check standards and scanning programs for classified protection compliance for 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`: Enabled. `false`: Disabled. Default value: `false`.	false
internet_charge_type	string	The billing method for the public IP address of nodes. PayByBandwidth: billed on a fixed bandwidth basis. PayByTraffic: billed on a pay-by-traffic basis.	PayByBandwidth
internet_max_bandwidth_out	integer	The maximum outbound bandwidth for the public IP address of nodes, in Mbps (Mega bit per second). Valid values: 1 to 100.	10
tags	array	The ECS instance tags.
	tag	The node tag.	[{\"key\":\"pkg.E2EClient.ClusterId\",\"value\":\"troopers-\"}]
desired_size	integer	The desired 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`: Scales based on the vSwitches (VSwitchIds.N) that you define. When 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`: 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 methods, spot instances are preferentially created. 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`: Evenly allocates ECS instances across the multiple active zones specified in the scaling group. If the zones become unbalanced due to insufficient inventory, you can call the `RebalanceInstances` API operation to rebalance resources. For more information, see RebalanceInstances.	COST_OPTIMIZED
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 ECS instances, which improves the speed of subsequent scaling operations. (Stopped instances are not charged for compute resources, but storage fees still apply, 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,1000]. Pay-as-you-go instances are preferentially created when the number of pay-as-you-go instances is less than this value.	0
on_demand_percentage_above_base_capacity	integer	The percentage of pay-as-you-go instances among the extra instances that exceed the minimum number of pay-as-you-go instances (`on_demand_base_capacity`) in the scaling group. Valid values: [0,100].	20
spot_instance_pools	integer	The number of available instance types. The scaling group creates spot instances across the lowest-cost instance types in a balanced manner. Valid values: [1,10].	5
spot_instance_remedy	boolean	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`: Enabled. `false`: Disabled.	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 cost or inventory reasons. Valid values: `true`: Allows automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements. `false`: Does not allow automatic creation of pay-as-you-go instances to meet ECS instance quantity requirements.	true
deploymentset_id	string	The deployment set ID.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	If RDS instances are specified, the ECS instances in the cluster node are automatically added to the whitelist of the RDS instances.
	string	The ApsaraDB RDS instance.	rm-xxx
private_pool_options	object	The private pool options.
id	string	The private pool ID, which is the ID of the elasticity assurance or capacity reservation.	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 is generated for instance launch. Valid values: `Open`: open mode. Automatically matches open private pool capacity. If no matching private pool capacity is available, public pool resources are used. `Target`: targeted mode. Uses the specified private pool capacity to launch instances. If the specified private pool capacity is unavailable, the instance fails to launch. `None`: none mode. The instance does not use private pool capacity.	Open
security_group_id	string	[This field is deprecated] 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-2ze1iuk12m2sb4c4****
platform	string	[This field is deprecated] The operating system distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore`	AliyunLinux
ram_policy	string	This field is 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****
resource_pool_options	object	The resource pool and resource pool policy used when creating instances.
strategy	string	The resource pool policy used when creating instances. Valid values: PrivatePoolFirst: private pool first. PrivatePoolOnly: private pool only. None: no resource pool policy.	PrivatePoolFirst
private_pool_ids	array	The list of private pool IDs.
	string	The private pool ID.	eap-bp1c1fohub5jccwi****
system_disk_snapshot_policy_id	string	The system cloud disk snapshot policy.	sp-0jl6xnmme8v7o935****
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 label configuration.	{}
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 information.
runtime	string	The container runtime. 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 cluster versions 1.12.6 and 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.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****
unschedulable	boolean	Specifies whether the 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 of 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. The 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 to take 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.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD
tee_config	object	The confidential computing configuration.
tee_enable	boolean	Specifies whether to enable confidential computing for the cluster. Valid values: `true`: Enabled. `false`: Disabled.	false
interconnect_config	object	[This field is deprecated] The network configuration for edge node pools. This value is meaningful only for edge-type node pools.
cen_id	string	[This field is deprecated] The Cloud Enterprise Network (CEN) instance ID bound to the enhanced edge node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[This field is deprecated] The Cloud Connect Network (CCN) instance ID bound to the enhanced edge node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[This field is deprecated] The region of the Cloud Connect Network instance bound to the enhanced edge node pool.	cn-shanghai
bandwidth	integer	[This field is deprecated] The network bandwidth of the enhanced edge node pool, in Mbps.	10
improved_period	string	[This field is deprecated] The subscription duration of the enhanced edge node pool, in months.	1
max_nodes	integer	The maximum number of nodes allowed in the edge node pool. This parameter specifies the maximum number of nodes that the node pool can contain and must be greater than or equal to 0. A value of 0 indicates no additional limit (limited only by the maximum number of nodes the cluster can contain, with no additional limit on the node pool itself). This value is typically greater than 0 for edge node pools. For ess-type node pools and default edge-type node pools, this value is 0.	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
auto_mode	object	The intelligent managed configuration.
enable	boolean	Specifies whether to enable intelligent managed mode.	true
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 node component custom configuration.	{"cpuManagerPolicy":"static"}
	any	The node component custom configuration string.	cpuManagerPolicy
config_revision	string	The node component custom configuration revision number.	1
eflo_node_group	object	The Lingjun node group information.
cluster_id	string	The Lingjun cluster ID.	i113790071760688002461
group_id	string	The Lingjun group ID.	i128147721760688002463
auto_attach_enabled	boolean	Specifies whether to enable automatic node addition for the Lingjun node pool (not effective).
worker_ram_role_name	string	The worker RAM role used by the Lingjun node pool.

Examples

Success response

JSON format

{
  "nodepools": [
    {
      "nodepool_info": {
        "nodepool_id": "np615c0e0966124216a0412e10afe0****",
        "name": "default-nodepool",
        "type": "ess",
        "is_default": true,
        "resource_group_id": "rg-acfmyvw3wjm****",
        "region_id": "cn-beijing",
        "created": "2025-04-15T16:33:29.362888807+08:00",
        "updated": "2025-04-15T16:33:32.823+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
      },
      "auto_scaling": {
        "enable": true,
        "type": "cpu",
        "max_instances": 10,
        "min_instances": 2,
        "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-xxxxxxxxx"
        },
        "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-2ze8n5qw4atggut8****",
        "vswitch_ids": [
          "vsw-2ze3ds0mdip0hdz8i****"
        ],
        "instance_types": [
          "ecs.n4.large"
        ],
        "instance_charge_type": "PostPaid",
        "period": 1,
        "period_unit": "Month",
        "auto_renew": false,
        "auto_renew_period": 0,
        "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": [
          "EESSD云盘"
        ],
        "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****"
          }
        ],
        "disk_init": [
          {
            "disk_name": "disk0",
            "mkfs_type": "ext4",
            "mount_target": "/mnt/disk0",
            "mount_for_runtime": false,
            "local_disk": false
          }
        ],
        "security_group_ids": [
          "sg-2ze1iuk12m2sb4c4****"
        ],
        "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": "COST_OPTIMIZED",
        "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,
        "deploymentset_id": "ds-bp1d19mmbsv3jf6xxxxx",
        "rds_instances": [
          "rm-xxx"
        ],
        "private_pool_options": {
          "id": "eap-bp67acfmxazb4****",
          "match_criteria": "Open"
        },
        "security_group_id": "sg-2ze1iuk12m2sb4c4****",
        "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****",
        "resource_pool_options": {
          "strategy": "PrivatePoolFirst",
          "private_pool_ids": [
            "eap-bp1c1fohub5jccwi****"
          ]
        },
        "system_disk_snapshot_policy_id": "sp-0jl6xnmme8v7o935****"
      },
      "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": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****",
        "unschedulable": true,
        "cms_enabled": true,
        "node_name_mode": "aliyun.com192.XX.YY.55test",
        "pre_user_data": "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD"
      },
      "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",
      "auto_mode": {
        "enable": true
      },
      "node_components": [
        {
          "name": "kubelet",
          "version": "1.33.3-aliyun.1",
          "config": {
            "custom_config": {
              "key": "cpuManagerPolicy"
            }
          },
          "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.