Query ENS Cluster Node Pools via API with Pagination - ENS - Alibaba Cloud - ENS

Lists all node pools in a cluster.

Operation description

Single-user call frequency: 100 calls per second.

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

ens:DescribeClusterNodePools

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	eck-xxxxxxxx
PageNumber	integer	Yes	The page number to return. Pages are numbered starting from 1.	1
PageSize	integer	Yes	The number of entries to return per page.	10

Response elements

Element	Type	Description	Example
	object	The schema of the response.
Page	object	The pagination details.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	20
NodePools	array<object>	The list of node pools.
	array<object>
NodepoolInfo	object	The details of the node pool.
Name	string	The name of the node pool.	eck-node-pool-1
EnsRegionId	string	The ID of the ENS node.	cn-fuzhou-23
NodepoolId	string	The ID of the node pool.	np68mi5y1dd748ky37ojo2kqdrz
ScalingGroup	object	The scaling group configuration.
VswitchIds	array	The IDs of the vSwitches.
	string	The ID of a vSwitch.	vsw-58eu2p6v64qw8ihhit1wz7wgv
InstanceChargeType	string	The billing method of the instances.	PrePaid
InstanceTypes	array	The list of instance types.
	string	The instance type.	ens.sn1.small
SystemDiskCategory	string	The category of the system disk. Valid values: `local_ssd`, `cloud_ssd`, `cloud_efficiency`, and `local_hdd`.	cloud_efficiency
SystemDiskSize	integer	The size of the system disk, in GB.	80
ImageId	string	The ID of the image.	m-673f5z4h69ibwtallg6zmcaxr
KeyPairName	string	The name of the key pair.	key-pair-name
DataDisks	array<object>	The list of data disks. The parameter constraints are the same as those for the system disk.
	object	A data disk.
Category	string	The category of the data disk.	cloud_efficiency
Size	integer	The size of the data disk, in GB.	80
Password	string	The password for the instances.	************
KubernetesConfig	object	The Kubernetes configuration.
PreUserData	string	The user data script to run on nodes before they are added to the cluster. The script must be Base64-encoded.	ZWNobyBvawo=
UserData	string	The user data script to run on nodes after they are added to the cluster. The script must be Base64-encoded.	ZWNobyBvawo=
Status	object	The status of the node pool.
State	string	The state of the node pool. Valid values: `active`: The node pool is active. `scaling`: The node pool is scaling out. `removing_nodes`: The node pool is scaling in.	active
TotalNodes	integer	The total number of instances, including those that are being created, in service, or being removed.	10
DesiredNodes	integer	The expected number of instances.	10
ServingNodes	integer	The number of instances in service.	10
InitialNodes	integer	The number of instances that are being created.	0
RemovingNodes	integer	The number of instances that are being removed.	0
FailedNodes	integer	The number of failed instances.	0
ClusterId	string	The ID of the cluster.	eck-xxxxxxxx
RequestId	string	The request ID.	F3B261DD-3858-4D3C-877D-303ADF374600

Examples

Success response

JSON format

{
  "Page": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  },
  "NodePools": [
    {
      "NodepoolInfo": {
        "Name": "eck-node-pool-1",
        "EnsRegionId": "cn-fuzhou-23",
        "NodepoolId": "np68mi5y1dd748ky37ojo2kqdrz"
      },
      "ScalingGroup": {
        "VswitchIds": [
          "vsw-58eu2p6v64qw8ihhit1wz7wgv"
        ],
        "InstanceChargeType": "PrePaid",
        "InstanceTypes": [
          "ens.sn1.small"
        ],
        "SystemDiskCategory": "cloud_efficiency",
        "SystemDiskSize": 80,
        "ImageId": "m-673f5z4h69ibwtallg6zmcaxr",
        "KeyPairName": "key-pair-name",
        "DataDisks": [
          {
            "Category": "cloud_efficiency",
            "Size": 80
          }
        ],
        "Password": "************"
      },
      "KubernetesConfig": {
        "PreUserData": "ZWNobyBvawo=",
        "UserData": "ZWNobyBvawo="
      },
      "Status": {
        "State": "active",
        "TotalNodes": 10,
        "DesiredNodes": 10,
        "ServingNodes": 10,
        "InitialNodes": 0,
        "RemovingNodes": 0,
        "FailedNodes": 0
      },
      "ClusterId": "eck-xxxxxxxx"
    }
  ],
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.