Queries the list of nodes in a cluster.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ehpc:ListNodes | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The ID of the cluster. You can call the ListClusters operation to query the cluster ID. | ehpc-hz-FYUr32**** |
| Role | string | No | The type of the node. Valid values:
| Manager |
| HostName | string | No | The name of the node. You can perform a fuzzy search. MySQL regular expressions are supported. | test-HostName |
| PageNumber | integer | No | The number of the page to return. Pages start from page 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10. | 10 |
| Sequence | string | No | The sorting method of the node list. Valid values:
Default value: Forward. Note
This parameter is used together with the SortBy parameter. If you set SortBy to AddedTime and set Sequence to Forward, nodes are queried in ascending order of time that they are added.
| Forward |
| SortBy | string | No | The sorting method of the node list. Valid values:
| AddedTime |
| Filter | string | No | The filter options of the node list. Format: {"status":"node_status"}. Replace node_status with the node status. Valid values of node_status:
| {"status":"running"} |
| PrivateIpAddress | string | No | The private IP address of the node. | 172.16.**.** |
| HostNamePrefix | string | No | The prefix of the hostname. You can query nodes that have a specified prefix. | compute |
| HostNameSuffix | string | No | The suffix of the hostname. You can query nodes that have a specified suffix. | 01 |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 1,
"RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
"PageNumber": 1,
"TotalCount": 1,
"Nodes": {
"NodeInfo": [
{
"VpcId": "vpc-bp1gnu8br4ay7beb2w****",
"Status": "running",
"HtEnabled": true,
"Expired": false,
"ImageOwnerAlias": "system",
"LockReason": "financial",
"HostName": "test-HostName",
"InstanceType": "ecs.c5.large",
"PublicIpAddress": "172.16.**.**",
"SpotStrategy": "NoSpot",
"CreatedByEhpc": true,
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-bp1e47optm9g58zcu****",
"IpAddress": "172.16.**.**",
"ExpiredTime": "2020-06-09T06:22:02.000Z",
"Version": "1.0.78",
"ZoneId": "cn-hangzhou-b",
"AddTime": "2020-06-09T06:22:02.000Z",
"ImageId": "centos_7_06_64_20G_alibase_20190711.vhd",
"Location": "PublicCloud",
"Id": "i-bp15707mys2rsy0j****",
"CreateMode": "manual",
"Roles": {
"Role": [
"[“Compute”]"
]
},
"TotalResources": {
"Gpu": 0,
"Cpu": 1,
"Memory": 1024
},
"UsedResources": {
"Gpu": 0,
"Cpu": 0,
"Memory": 0
},
"StateInSched": "active"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 400 | NotEnabled | You have not enabled this service | You have not enabled this service |
| 404 | ClusterNotFound | The specified cluster does not exist. | The specified instance does not exist. |
| 404 | ManagerNotFound | The manager nodes do not exist or their status is abnormal. | The manager nodes do not exist or their status is abnormal. |
| 406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
| 406 | DbError | A database service error occurred. | Database request failed. |
| 406 | RedisError | A Redis service error occurred. | Redis request failed. |
| 406 | AgentError | The agent service request failed. | - |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | An Alibaba Cloud product error occurred. |
| 407 | NotAuthorized | You are not authorized by RAM for this request. | The request is not authorized by RAM. |
| 500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | The request has failed due to a temporary failure of the server. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-12-22 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||||||||
|