Queries the nodes of an Elastic High Performance Computing (E-HPC) 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:
- For mandatory resource types, indicate with a prefix of * .
- 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 | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | No | The cluster ID. You can call the ListClusters operation to query the cluster ID. | ehpc-hz-FYUr32**** |
| Hostnames | array | No | The hostnames of the compute nodes that you want to query. | |
| string | No | The hostname. | compute000 | |
| PrivateIpAddress | array | No | The IP addresses of the compute nodes that you want to query. | |
| string | No | The Virtual Private Cloud (VPC) IP address of the compute node. | 172.16.**.** | |
| PageNumber | integer | No | The page number of the page to return. | 1 |
| PageSize | integer | No | The number of entries per page. | 1 |
| Sequence | string | No | Specifies whether the results are sorted in ascending or descending order. Valid values:
Default value: Forward. | Forward |
| SortBy | string | No | The sorting method of the node list. Valid values:
Default value: addedtime. | AddedTime |
| QueueNames | array | No | The queues to which the nodes belong. | |
| string | No | The queue name. | comp | |
| Status | array | No | The states of the compute nodes to be queried. | |
| string | No | The state of the compute node. Valid values:
| running |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 1,
"RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
"PageNumber": 1,
"TotalCount": 1,
"Nodes": [
{
"VpcId": "vpc-bp1gnu8br4ay7beb2w****",
"Status": "running",
"HtEnabled": true,
"Hostname": "edas.cn-shanghai.aliyuncs.com",
"InstanceType": "ecs.c5.large",
"PublicIpAddress": "172.16.**.**",
"SpotStrategy": "NoSpot",
"VSwitchId": "vsw-bp1e47optm9g58zcu****",
"IpAddress": "172.16.**.**",
"ExpiredTime": "2020-06-09T06:22:02.000Z",
"ZoneId": "cn-hangzhou-b",
"AddTime": "2020-06-09T06:22:02.000Z",
"ImageId": "centos_7_06_64_20G_alibase_20190711.vhd",
"Id": "i-bp15707mys2rsy0j****",
"TotalResources": {
"Gpu": 0,
"Cpu": 1,
"Memory": 1024
},
"StateInSched": "active",
"QueueName": "autoque3",
"KeepAlive": true,
"DeploymentSetId": "ds-8vbe4av4gededlqg****"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-04 | The response structure of the API has changed | View Change Details |