查询用户账号中在每个地域拥有的所有集群的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ehpc:ListClusters | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 显示的页码,起始值为 1。 | 1 |
PageSize | integer | 否 | 每页显示的条数。取值范围:1~50 默认值:10 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"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
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数:%s |
404 | ImageNotFound | The specified image does not exist. | 指定的镜像不存在,请您检查该参数是否正确。 |
406 | AgentError | The agent service request failed. | 集群侧命令运行失败 |
406 | DbError | A database service error occurred. | 数据库请求失败 |
406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
406 | EcsError | An error occurred while calling the ECS API operation. | ECS API调用出错 |
407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
407 | EntityNotExist.Role | The role does not exist. | 当前角色不存在 |
500 | UnknownError | An unknown error occurred. | 未知错误 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-04-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||||
|