全部产品
云市场

ListClusters

更新时间:2018-08-08 11:15:15

查询集群列表。

描述

查询用户账号中在每个地域拥有的所有集群的列表。查询集群列表前,您可以:

请求参数

名称 类型 是否必需 默认值 描述
Action String - 操作接口名,系统规定参数,取值:ListClusters
RegionId String - 地域 ID。
PageNumber Integer 1 显示的页码,起始值为 1。
PageSize Integer 10 每页显示的条数,1-50。

返回参数

公共返回参数外返回如下结果:

名称 类型 描述
Clusters Array<ClusterInfoSimple> 集群简要信息数组,ClusterInfoSimple 结构见下面的对象描述。
TotalCount Integer 列表条目总数。
PageNumber Integer 当前页码。
PageSize Integer 本页条数。

其中,每个 ClusterInfoSimple 结构包含以下字段:

名称 取值 描述
Id String 集群 ID。
RegionId String 地域 ID。
Name String 集群名字。
Description String 集群描述。
Status String 集群状态。
OsTag String 操作系统镜像标签,可以通过 ListImages 查询操作系统详情。
AccountType String 账户服务器类型,现在仅支持 nis
SchedulerType String 调度服务器类型,现在仅支持 pbs
Count Integer 集群中计算节点的数目。
InstanceType String 集群中计算节点的规格,例如 ecs.n1.large。
CreateTime String 创建时间。
ImageOwnerAlias String 镜像类型,取值:systemselfothersmarketplace
ImageId String 镜像 Id。
Location String 集群所在位置。OnPremise:本地集群(混合云),PublicCloud:公共云。
DeployMode String 部署模式:
Standard: 账号节点 + 调度节点 + 登录节点 + 计算节点
Advanced: HA模式
Simple: (账号 + 调度)节点 + 登录节点 + 计算节点
Tiny:(账号 + 调度 + 登录)节点 + 计算节点
OneBox:(账号 + 调度 + 登录 + 计算)节点 + 更多计算节点
LoginNodes String 登录节点列表, [{Id:}]
TotalResources ResourceType 集群资源总量。
UsedResources ResourceType 集群资源使用量。
Managers NodeResourceInfo 管理节点统计信息。
Computes NodeResourceInfo 计算节点统计信息。

集群状态 Status 的可能取值:

取值 描述
uninit 未初始化
creating 创建中
init 初始化中
running 运行中
exception 异常
releasing 释放中

ResourceType 结构包含以下字段:

名称 取值 描述
Cpu Integer CPU资源,单位:核
Memory Integer 内存资源,单位:MB
Gpu Integer GPU资源,单位:卡

NodeResourceInfo 结构包含以下字段:

名称 取值 描述
Total Integer 总的节点数
NormalCount Integer 正常节点数
OperatingCount Integer 操作进行中的节点数(初始化,安装中,释放中等状态)
StoppedCount Integer 停止的节点数
ExceptionCount Integer 异常节点数

示例

请求示例

  1. https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListClusters&RegionId=cn-hangzhou&<公共请求参数>

返回示例

XML格式

  1. <ListClustersResponse>
  2. <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>1</PageSize>
  6. <Clusters>
  7. <ClusterInfoSimple>
  8. <Id>ehpc-hz-4VMqwGqwbj</Id>
  9. <RegionId>cn-hangzhou</RegionId>
  10. <ZoneId>cn-hangzhou-e</ZoneId>
  11. <Name>Example-cluster-name</Name>
  12. <Description>Example cluster description</Description>
  13. <Status>running</Status>
  14. <AccountType>nis</AccountType>
  15. <SchedulerType>pbs</SchedulerType>
  16. <DeployMode>Standard</DeployMode>
  17. <Count>1</Count>
  18. <InstanceType>ecs.n1.tiny</InstanceType>
  19. <LoginNodes>[{"Id":"i-bp19oxc76s5iggdgudgw"}]</LoginNodes>
  20. <CreateTime>2018-05-30T03:08:06.000Z</CreateTime>
  21. <ImageOwnerAlias>system</ImageOwnerAlias>
  22. <ImageId>centos_7_02_64_20G_alibase_20170818.vhd</ImageId>
  23. <Location>public_cloud</Location>
  24. <Managers>
  25. <Total>2</Total>
  26. <NormalCount>2</NormalCount>
  27. <OperationCount>0</OperationCount>
  28. <StoppedCount>0</StoppedCount>
  29. <ExceptionCount>0</ExceptionCount>
  30. </Managers>
  31. <Computes>
  32. <Total>1</Total>
  33. <NormalCount>1</NormalCount>
  34. <OperationCount>0</OperationCount>
  35. <StoppedCount>0</StoppedCount>
  36. <ExceptionCount>0</ExceptionCount>
  37. </Computes>
  38. <TotalResources>
  39. <Cpu>1</Cpu>
  40. <Memory>1024</Memory>
  41. <Gpu>0</Gpu>
  42. </TotalResources>
  43. <UsedResources>
  44. <Cpu>0</Cpu>
  45. <Memory>0</Memory>
  46. <Gpu>0</Gpu>
  47. </UsedResources>
  48. </ClusterInfoSimple>
  49. </Clusters>
  50. </ListClustersResponse>

JSON格式

  1. {
  2. "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
  3. "TotalCount": 1,
  4. "PageNumber": 1,
  5. "PageSize": 1,
  6. "Clusters": {
  7. "ClusterInfoSimple" : [
  8. {
  9. "Id": "ehpc-hz-4VMqwGqwbj",
  10. "RegionId": "cn-hangzhou",
  11. "ZoneId": "cn-hangzhou-e",
  12. "Name": "Example-cluster-name",
  13. "Description": "Example cluster description",
  14. "Status": "running",
  15. "AccountType": "nis",
  16. "SchedulerType": "pbs",
  17. "DeployMode": "Standard",
  18. "Count": 1,
  19. "InstanceType": "ecs.n1.tiny",
  20. "LoginNodes": "[{‘Id’:‘i-bp19oxc76s5iggdgudgw’}]"
  21. "CreateTime": "2018-05-30T03:08:06.000Z",
  22. "ImageOwnerAlias": "system",
  23. "ImageId": "centos_7_02_64_20G_alibase_20170818.vhd",
  24. "Location": "public_cloud",
  25. "Managers" : {
  26. "Total": 2,
  27. "NormalCount": 2,
  28. "OperationCount": 0,
  29. "StoppedCount": 0,
  30. "ExceptionCount": 0
  31. },
  32. "Computes" : {
  33. "Total": 1,
  34. "NormalCount": 1,
  35. "OperationCount": 0,
  36. "StoppedCount": 0,
  37. "ExceptionCount": 0
  38. },
  39. "TotalResources": {
  40. "Cpu": 1,
  41. "Memory": 1024,
  42. "Gpu": 0
  43. },
  44. "UsedResources": {
  45. "Cpu": 0,
  46. "Memory": 0,
  47. "Gpu": 0
  48. }
  49. }
  50. ]
  51. }
  52. }

错误码

查询 E-HPC 接口错误码请访问 错误码。更多错误码,请访问 API 错误中心