Query Edge Cluster Nodes via DescribeClusterNodes API - ENS - Alibaba Cloud - ENS

You can call the DescribeClusterNodes operation to query information about nodes that meet specified criteria.

Operation description

The maximum call frequency for a single user is 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:DescribeClusterNodes

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	eck-xxxxxxxx
NodepoolId	string	Yes	The node pool ID.	np751e9d5464cf4ef081087137f33e4528
PageNumber	integer	Yes	The page number. The value starts from 1.	1
PageSize	integer	Yes	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response schema.
Page	object	The paging information.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries on the current page.	10
TotalCount	integer	The total number of entries.	30
Nodes	array<object>	The node information.
	object	The node information.
ClusterId	string	The cluster ID.	eck-xxxxxxxx
EnsRegionId	string	The ENS node ID.	cn-fuzhou-23
NodepoolId	string	The node pool ID.	np861febb748f84f5f9f1c76819eff7f56
InstanceId	string	The instance ID.	i-51mctytg7tv4yw4amu3oczxsx
PayType	string	The billing method. The value is PostPaid (pay-as-you-go).	PrePaid
ImageId	string	The ID of the instance image.	m-680cki2ruj1q2bm0mz1k9tnbz
IpAddress	array	The IP address of the ENS instance.
	string	The IP address of the ENS instance.	111.1111.111.111
State	string	The status of the node pool. initial: The node pool is being created. running: The node pool is created. removing: The node pool is being removed.	initial
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

{
  "Page": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 30
  },
  "Nodes": [
    {
      "ClusterId": "eck-xxxxxxxx",
      "EnsRegionId": "cn-fuzhou-23",
      "NodepoolId": "np861febb748f84f5f9f1c76819eff7f56",
      "InstanceId": "i-51mctytg7tv4yw4amu3oczxsx",
      "PayType": "PrePaid",
      "ImageId": "m-680cki2ruj1q2bm0mz1k9tnbz",
      "IpAddress": [
        "111.1111.111.111"
      ],
      "State": "initial"
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.