DescribeClusterNodePools-阿里云帮助中心

You can list all the node pools in a cluster.

Try it now

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

Test

RAM authorization

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

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

Action

Access level

Resource type

Condition key

Dependent action

cs: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 name of the node pool.	nodepool-test

Response elements

Element	Type	Description	Example
	object	The details of the node pool.
nodepools	array<object>	The list of node pools.
	array<object>	The details of the node pool.
nodepool_info	object	The information about the node pool.
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`: A regular node pool. This type of node pool supports managed features and auto scaling. `edge`: An edge node pool. `lingjun`: A Lingjun node pool.	ess
is_default	boolean	Indicates whether the node pool is the default node pool. A cluster usually 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 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 status of the node pool.
state	string	The status of the node pool. Valid values: `active`: The node pool is active. `scaling`: The node pool is being scaled. `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 nodes in service.	3
total_nodes	integer	The total number of nodes in the node pool.	3
auto_scaling	object	The auto scaling configurations.
enable	boolean	Indicates whether to enable auto scaling. Valid values: `true`: Enables auto scaling for the node pool. If the resource planning of the cluster cannot meet the scheduling requirements of application pods, ACK automatically scales out or scales in nodes based on the configured minimum and maximum numbers of instances. For clusters of Kubernetes 1.24 or later, instant scaling is enabled by default. For clusters of a Kubernetes version earlier than 1.24, node autoscaling is enabled by default. For more information, see Node scaling. `false`: Disables auto scaling. ACK adjusts the number of nodes in the node pool to the configured expected number of nodes. If this parameter is set to false, the other parameters in auto_scaling do not take effect.	true
type	string	The type of auto scaling. This parameter specifies the type of instances that are used for auto scaling. Valid values: `cpu`: regular instances. `gpu`: GPU-accelerated instances. `gpushare`: shared GPU-accelerated instances. `spot`: spot instances.	cpu
max_instances	integer	The maximum number of instances that can be created in the node pool. This value does not include the existing instances.	10
min_instances	integer	The minimum number of instances that can be created in the node pool. This value does not include the existing instances.	2
eip_internet_charge_type	string	The billing method of the EIP. Valid values: `PayByBandwidth`: pay-by-bandwidth. `PayByTraffic`: pay-by-traffic.	PayByBandwidth
is_bond_eip	boolean	Indicates whether to associate an EIP with the node. Valid values: `true`: Associates an EIP with the node. `false`: Does not associate an EIP with the node.	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. This parameter takes effect only in ACK Pro clusters.
enable	boolean	Indicates whether to enable the managed node pool feature. Valid values: `true`: Enables the managed node pool feature. `false`: Disables the managed node pool feature. The other parameters in this object do not take effect if you set this parameter to false.	true
auto_repair	boolean	Indicates whether to enable auto repair. This parameter takes effect only if enable is set to true. `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 to allow node restart. This parameter takes effect only if auto_repair is set to true. `true`: Allows node restart. `false`: Does not allow node restart.	true
approval_required	boolean	Indicates whether manual approval is required for node repairs.	false
auto_repair_policy_id	string	The ID of the auto repair policy	r-xxxxxxxxx
auto_vul_fix	boolean	Indicates whether to automatically fix CVEs. This parameter takes effect only if enable is set to true. `true`: Allows CVEs to be automatically fixed. `false`: Does not allow CVEs to be automatically fixed.	true
auto_vul_fix_policy	object	The policy for automatically fixing CVEs.
restart_node	boolean	Indicates whether to allow node restart. This parameter takes effect only if auto_vul_fix is set to true. Valid values: `true`: Allows node restart. `false`: Does not allow node restart.	true
vul_level	string	The CVE levels for which CVEs are automatically fixed. Separate multiple CVE levels with commas. `asap`: high `later`: medium `nntf`: low	asap,nntf
exclude_packages	string	The packages that should be excluded from the CVE fixing process.	kernel
auto_upgrade	boolean	Indicates whether to enable auto update. This parameter takes effect only if enable is set to true. `true`: Enables auto update. `false`: Disables auto update.	true
auto_upgrade_policy	object	The auto update policy.
auto_upgrade_kubelet	boolean	Indicates whether to automatically update the kubelet. This parameter takes effect only if auto_upgrade is set to true. Valid values: `true`: Allows the kubelet to be automatically updated. `false`: Does not allow the kubelet to be automatically updated.	true
upgrade_config	object	The auto update configurations. This parameter takes effect only if enable is set to true.
auto_upgrade	boolean	Indicates whether to enable auto update. Valid values: `true`: Enables auto update. `false`: Disables auto update.	true
surge	integer	The number of extra nodes. You can specify only one of surge and surge_percentage.	5
surge_percentage	integer	The percentage of extra nodes. You can specify only one of surge and surge_percentage. The number of extra nodes = Percentage of extra nodes × Number of nodes. For example, if you set the percentage of extra nodes to 50% and the number of existing nodes is 6, three extra nodes are created.	50
max_unavailable	integer	The maximum number of unavailable nodes. Valid values: 1 to 1000 Default value: 1.	1
auto_fault_diagnosis	boolean
scaling_group	object	The configurations of the scaling group for the node pool.
scaling_group_id	string	The ID of the scaling group.	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. When a node is created, the system starts from the first instance type until the node is created. The instance type that is used to create the node may vary based on the inventory.	ecs.n4.large
	string	The node instance type.	ecs.n4.large
instance_charge_type	string	The billing method of the nodes in the node pool. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go.	PostPaid
period	integer	The subscription duration of the nodes. This parameter is required and takes effect only if instance_charge_type is set to PrePaid. If period_unit is set to Week, you can set period to one of the following values: 1, 2, 3, and 4. If period_unit is set to Month, you can set period to one of the following values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.	1
period_unit	string	The billing cycle of the nodes. This parameter is required if instance_charge_type is set to PrePaid. `Month`: The billing cycle is measured in months. `Week`: The billing cycle is measured in weeks.	Month
auto_renew	boolean	Indicates whether to enable auto-renewal for the nodes. This parameter takes effect only if 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: If PeriodUnit is set to Week: 1, 2, and 3. If PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60.	0
spot_strategy	string	The type of the spot instance. Valid values: NoSpot: A regular pay-as-you-go instance. SpotWithPriceLimit: A spot instance for which you can set a maximum hourly price. SpotAsPriceGo: A spot instance for which the system automatically bids based on the market price. For more information, see Spot instances.	NoSpot
spot_price_limit	array<object>	The configurations of the price range for the spot instance.
	object	The configurations of the price range for the spot instance. 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 price range for a single instance. Unit: CNY/hour.	0.39
image_type	string	The OS 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 the DescribeKubernetesVersionMetadata operation to query the images that are supported by the system.	aliyun_3_x64_20G_alibase_20241218.vhd
system_disk_category	string	The type of the system disk. Valid values: `cloud_efficiency`: ultra disk. `cloud_ssd`: standard SSD. `cloud_essd`: enterprise SSD (ESSD). `cloud_auto`: ESSD AutoPL disk. `cloud_essd_entry`: ESSD Entry disk.	cloud_efficiency
system_disk_categories	array	The multi-disk type of the system disk. When a disk of a high-priority type is unavailable, the system automatically tries the next-priority disk type to create the system disk.
	string	The type of the system disk. Valid values: `cloud_efficiency`: ultra disk. `cloud_ssd`: standard SSD. `cloud_essd`: ESSD. `cloud_auto`: ESSD AutoPL disk. `cloud_essd_entry`: ESSD Entry disk.	EESSD云盘
system_disk_size	integer	The size of the system disk. Unit: GiB. Valid values: 20 to 2048.	120
system_disk_performance_level	string	The performance level of the system disk. This parameter takes effect only for ESSDs. The disk performance level is related to the disk size. For more information, see ESSDs. PL0: The concurrent I/O performance is moderate, and the read and write latency is stable. PL1: The concurrent I/O performance is moderate, and the read and write latency is stable. PL2: The concurrent I/O performance is high, and the read and write latency is stable. PL3: The concurrent I/O performance is extremely high, and the read and write latency is extremely stable.	PL1
system_disk_encrypted	boolean	Indicates whether to encrypt the system disk. Valid values: true: Encrypts the system disk. false: Does not encrypt the system disk.	false
system_disk_kms_key_id	string	The ID of the KMS key that is used to encrypt the system disk.	0e478b7a-4262-4802-b8cb-00d3fb40****
system_disk_encrypt_algorithm	string	The encryption algorithm that is used for the system disk. Valid values: aes-256.	aes-256
system_disk_bursting_enabled	boolean	Indicates whether to enable the performance burst feature for the system disk. Valid values: `true`: Enables the feature. After this feature is enabled, the disk performance is temporarily improved to handle unexpected data read and write pressure when your business becomes unstable. `false`: Disables the feature. This parameter can be set only when system_disk_category is set to cloud_auto. For more information, see ESSD AutoPL disks.	true
system_disk_provisioned_iops	integer	The pre-configured read and write IOPS of the system disk. This parameter is configured when the disk type is cloud_auto.	1000
data_disks	array	The configurations of the data disks, such as the disk type and size.
	data_disk	The data disk configurations.
disk_init	array	The configurations for initializing block devices.
	DiskInit	The DiskInit configurations.
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 name of the key pair. You must set one of key_pair and 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 set one of key_pair and login_password. 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 is encrypted.	******
login_as_non_root	boolean	Indicates whether to log on to the created ECS instances as a non-root user. true: Logs on as a non-root user (ecs-user). false: Logs on as the root user.	true
cis_enabled `deprecated`	boolean	[This parameter is deprecated] Use the security_hardening_os parameter instead.	false
soc_enabled	boolean	Indicates whether to enable MLPS 2.0 security hardening. You can enable MLPS 2.0 security hardening for nodes only when you select Alibaba Cloud Linux 2 or Alibaba Cloud Linux 3 as the OS. Alibaba Cloud provides baseline check standards and scanning programs for MLPS 2.0 Level 3-compliant versions of Alibaba Cloud Linux 2 and Alibaba Cloud Linux 3.	false
security_hardening_os	boolean	Alibaba Cloud OS security hardening. Valid values: `true`: Enables Alibaba Cloud OS security hardening. `false`: Disables Alibaba Cloud OS security hardening. Default value: `false`.	false
internet_charge_type	string	The billing method for the public IP address of the node. PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-traffic.	PayByBandwidth
internet_max_bandwidth_out	integer	The maximum outbound bandwidth of the public IP address of the node. Unit: Mbit/s. Valid values: 1 to 100.	10
tags	array	The tags of the ECS instances.
	tag	The node tags.	[{\"key\":\"pkg.E2EClient.ClusterId\",\"value\":\"troopers-\"}]
desired_size	integer	The expected number of nodes in the node pool.	2
multi_az_policy	string	The scaling policy for the ECS instances in the multi-zone scaling group. Valid values: `PRIORITY`: Scales instances based on the vSwitches that you define (VSwitchIds.N). If an ECS instance cannot be created in the zone where the vSwitch with a higher priority resides, the system automatically uses the vSwitch with the next priority to create the ECS instance. `COST_OPTIMIZED`: Creates instances at the lowest vCPU unit price. If multiple instance types are specified for the scaling configuration and preemptible instances are used, the system preferentially creates preemptible instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to reasons such as insufficient inventory. Note `COST_OPTIMIZED` takes effect only when multiple instance types are specified for the scaling configuration or preemptible instances are used. `BALANCE`: Evenly distributes ECS instances across the specified zones of the scaling group. If the distribution of ECS instances becomes unbalanced due to insufficient inventory, you can call the `RebalanceInstances` operation to rebalance the resources. For more information, see RebalanceInstances .	COST_OPTIMIZED
scaling_policy	string	The mode of the scaling group. Valid values: `release`: standard mode. ECS instances are created and released based on the resource usage. `recycle`: fast mode. ECS instances are created, stopped, and started to accelerate scaling. You are not charged for the computing resources of stopped instances, but you are charged for the storage resources. This does not apply to instances with local disks.	release
on_demand_base_capacity	integer	The minimum number of pay-as-you-go instances that are required by 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 instances that exceed 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. The scaling group creates preemptible instances of multiple instance types at the lowest cost. Valid values: 1 to 10.	5
spot_instance_remedy	boolean	Indicates whether to enable the feature of supplementing preemptible instances. If this feature is enabled, the scaling group attempts to create a new instance to replace a preemptible instance when the scaling group receives a system message that the preemptible instance is to be reclaimed. Valid values: `true`: Enables the feature of supplementing preemptible instances. `false`: Disables the feature of supplementing preemptible instances.	false
compensate_with_on_demand	boolean	If multi_az_policy is set to COST_OPTIMIZED, this parameter specifies whether to allow the system to automatically create pay-as-you-go instances to meet the required number of ECS instances when preemptible instances cannot be created due to reasons such as price and inventory. Valid values: `true`: Allows the system to automatically create pay-as-you-go instances to meet the required number of ECS instances. `false`: Does not allow the system to automatically create pay-as-you-go instances to meet the required number of ECS instances.	true
deploymentset_id	string	The deployment set ID.	ds-bp1d19mmbsv3jf6xxxxx
rds_instances	array	If you specify a list of RDS instances, the ECS instances of the cluster nodes are automatically added to the RDS instance whitelist.
	string	The RDS instance.	rm-xxx
private_pool_options	object	The private pool options.
id	string	The private pool ID. This is the ID of the elasticity assurance or capacity reservation.	eap-bp67acfmxazb4****
match_criteria	string	The type of the private node pool. This is the capacity option of the private pool that is used to start an instance. After an elasticity assurance or a capacity reservation service takes effect, a private pool is generated. You can select a private pool to start an instance. Valid values: `Open`: The system automatically matches an open private pool. If no matching private pool is found, the instance is started using public resources. `Target`: The instance is started using the capacity of a specified private pool. If the capacity of the specified private pool is unavailable, the instance fails to be started. `None`: The instance is started without using the capacity of a private pool.	Open
security_group_id	string	[This parameter is deprecated] The ID of the security group for the node pool. If the node pool is associated with multiple security groups, this is the first security group ID in `security_group_ids`.	sg-2ze1iuk12m2sb4c4****
platform	string	[This parameter is deprecated] The OS distribution. Valid values: `CentOS` `AliyunLinux` `Windows` `WindowsCore`	AliyunLinux
ram_policy	string	This parameter 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 name of the worker RAM role.	KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****
resource_pool_options	object	The resource pool and resource pool policy used when creating an instance.
strategy	string	The resource pool policy used when creating an instance. Valid values: PrivatePoolFirst: Private pool first. PrivatePoolOnly: Private pool only. None: No resource pool policy is used.	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 disk snapshot policy	sp-0jl6xnmme8v7o935****
node_config	object	The node configurations.
kubelet_configuration	kubelet_config	The kubelet parameter settings.
node_os_config	object	The node OS configurations.
hugepage	Hugepage	The Hugepage configurations.
kubernetes_config	object	The cluster-related configurations.
labels	array	The node labels.
	tag	The label configurations.	{}
taints	array	The node taints. Taints and tolerations work together to prevent pods from being scheduled to unsuitable nodes. For more information, see taint-and-toleration.
	taint	The node taints.
runtime	string	The name of the container runtime. ACK supports the following container runtimes. containerd: Recommended. This runtime is supported by all cluster versions. Sandboxed-Container.runv: a sandboxed container that provides higher isolation. This runtime is supported by clusters of Kubernetes 1.31 and earlier. docker: No longer maintained. This runtime is supported by clusters of Kubernetes 1.22 and earlier.	containerd
runtime_version	string	The version of the container runtime.	1.6.38
cpu_policy	string	The CPU management policy of the node. The following policies are supported by clusters of Kubernetes 1.12.6 and later: `static`: Allows pods with specific resource characteristics on a node to be granted enhanced CPU affinity and exclusivity. `none`: Enables the default CPU affinity scheme.	none
user_data	string	The custom data of the node pool. The script is run after the node is initialized. For more information, see Generate instance user data.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****
unschedulable	boolean	Indicates whether the scaled-out nodes are unschedulable. true: The nodes are unschedulable. false: The nodes are schedulable.	true
cms_enabled	boolean	Indicates whether to install CloudMonitor on the ECS nodes. After CloudMonitor is installed, you can view the monitoring information of the created ECS instances in the CloudMonitor console. We recommend that you enable this feature. Valid values: `true`: Installs CloudMonitor on the ECS nodes. `false`: Does not install CloudMonitor on the ECS nodes	true
node_name_mode	string	The custom node name. A node name consists of three parts: a prefix, the middle part of an IP address, and a suffix: The prefix and suffix can contain one or more parts that are 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 length of the IP address segment indicates the number of digits to be 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 prefix is aliyun.com, the length of the IP address segment 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 of the node pool. The script is run before the node is initialized. For more information, see Generate instance user data.	IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD
tee_config	object	The confidential computing configurations.
tee_enable	boolean	Indicates whether to enable confidential computing for the cluster. Valid values: `true`: Enables confidential computing. `false`: Disables confidential computing.	false
interconnect_config	object	[This parameter is deprecated] The network configurations of the edge node pool. This parameter is valid only for edge node pools.
cen_id	string	[This parameter is deprecated] The ID of the Cloud Enterprise Network (CEN) instance that is associated with the enhanced edge node pool.	cen-ey9k9nfhz0f*******
ccn_id	string	[This parameter is deprecated] The ID of the Cloud Connect Network (CCN) instance that is associated with the enhanced edge node pool.	ccn-qm5i0i0q9yi*******
ccn_region_id	string	[This parameter is deprecated] The region where the CCN instance of the enhanced edge node pool is deployed.	cn-shanghai
bandwidth	integer	[This parameter is deprecated] The network bandwidth of the enhanced edge node pool. Unit: Mbit/s.	10
improved_period	string	[This parameter is deprecated] The subscription duration of the enhanced edge node pool. Unit: months.	1
max_nodes	integer	The maximum number of nodes that are allowed in the edge node pool. This parameter is greater than or equal to 0. A value of 0 indicates that no upper limit is imposed on the number of nodes in the node pool, except for the upper limit on the total number of nodes in the cluster. For an edge node pool, the value of this parameter is usually greater than 0. For an ess-typed node pool or a default edge-typed node pool, the value of this parameter is 0	10
interconnect_mode	string	The network type of the edge node pool. This parameter is valid only for edge node pools. Valid values: `basic`: public network. The nodes in the node pool interact with cloud nodes over the Internet. Applications in the node pool cannot directly access the VPC in the cloud. `private`: private network. The nodes in the node pool are connected to the cloud over a leased line, a VPN connection, or a CEN instance to achieve higher communication quality and better security between the cloud and the edge.	basic
auto_mode	object	The intelligent hosting configurations.
enable	boolean	Indicates whether to enable intelligent hosting.	true
node_components	array<object>	The list of node components.
	array<object>	The node components.
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 configurations of the node component.
custom_config	object	The custom configurations of the node component.
	string	The custom configuration string of the node component.	cpuManagerPolicy
eflo_node_group	object	The information about the Lingjun node group.
cluster_id	string	The ID of the Lingjun cluster.	i113790071760688002461
group_id	string	The ID of the Lingjun group.	i128147721760688002463

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": ""
        },
        "auto_upgrade": true,
        "auto_upgrade_policy": {
          "auto_upgrade_kubelet": true
        },
        "upgrade_config": {
          "auto_upgrade": true,
          "surge": 5,
          "surge_percentage": 50,
          "max_unavailable": 1
        }
      },
      "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": true,
            "local_disk": true
          }
        ],
        "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": [
              ""
            ],
            "minimum_eni_quantity": 0,
            "minimum_eni_private_ip_address_quantity": 0,
            "minimum_eni_ipv6_address_quantity": 0,
            "maximum_gpu_amount": 0
          }
        ],
        "ram_role_name": "KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****",
        "resource_pool_options": {
          "strategy": "PrivatePoolFirst",
          "private_pool_ids": [
            ""
          ]
        },
        "system_disk_snapshot_policy_id": ""
      },
      "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": [
            ""
          ],
          "reservedMemory": [
            {
              "numaNode": 0,
              "limits": {
                "test": "test",
                "test2": 1
              }
            }
          ],
          "memoryManagerPolicy": "none",
          "cpuCFSQuota": true,
          "cpuCFSQuotaPeriod": "100ms",
          "imageGCHighThresholdPercent": 85,
          "imageGCLowThresholdPercent": 80,
          "podPidsLimit": -1,
          "topologyManagerPolicy": "restricted",
          "clusterDNS": [
            ""
          ],
          "tracing": {
            "endpoint": "localhost:4317",
            "samplingRatePerMillion": 0
          },
          "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"
            }
          }
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.