Queries the list of clusters in all regions within an account.
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:ListClusters | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| 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 50. Default value: 10 | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 1,
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"PageNumber": 1,
"TotalCount": 1,
"Clusters": {
"ClusterInfoSimple": [
{
"VpcId": "vpc-b3f3edefefeep0760yju****",
"Status": "running",
"CreateTime": "2020-10-30T07:39:20.000Z",
"IsComputeEss": false,
"ComputeSpotStrategy": "NoSpot",
"AccountType": "nis",
"Count": 3,
"EhpcVersion": "1.0.0",
"Description": "clusterdescription",
"BaseOsTag": "CentOS_7.2_64",
"Name": "test",
"ImageId": "wi_1607_x64_dtc_zh_40G_alibase****",
"ComputeSpotPriceLimit": 0.034,
"SchedulerType": "pbs",
"DeployMode": "Standard",
"NodeSuffix": "name",
"ImageOwnerAlias": "system",
"OsTag": "CentOS_7.2_64",
"NodePrefix": "test",
"InstanceType": "ecs.n1.tiny",
"RegionId": "cn-hangzhou",
"InstanceChargeType": "PostPaid",
"VSwitchId": "vsw-bp1lfcjbfb099rrjn****",
"ZoneId": "cn-hangzhou-c",
"LoginNodes": "{\"Id\": \"i-bp13x4is8pvdhws7e****\"}",
"Id": "ehpc-hz-jeJki6****",
"Location": "PublicCloud",
"ClientVersion": "1.0.64",
"ResourceGroupId": "rg-acfmxazb4ph****",
"Managers": {
"OperatingCount": 1,
"ExceptionCount": 0,
"StoppedCount": 0,
"Total": 2,
"NormalCount": 1
},
"Computes": {
"OperatingCount": 1,
"ExceptionCount": 0,
"StoppedCount": 0,
"Total": 2,
"NormalCount": 1
},
"TotalResources": {
"Gpu": 0,
"Cpu": 1,
"Memory": 1024
},
"UsedResources": {
"Gpu": 0,
"Cpu": 1,
"Memory": 1024
},
"HasPlugin": false
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 404 | ImageNotFound | The specified image does not exist. | The specified image does not exist. Please verify the parameter. |
| 406 | AgentError | The agent service request failed. | - |
| 406 | DbError | A database service error occurred. | Database request failed. |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | An Alibaba Cloud product error occurred. |
| 406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
| 407 | NotAuthorized | You are not authorized by RAM for this request. | The request is not authorized by RAM. |
| 407 | EntityNotExist.Role | The role does not exist. | The role does not exist. |
| 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 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-04-21 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||||||||
|