全部产品
云市场

ListNodes

更新时间:2018-11-13 19:46:52

查询集群中节点列表。

描述

查询用户集群中的节点列表,接口会返回所有节点信息。

请求参数

名称 类型 是否必需 默认值 描述
Action String - 操作接口名,系统规定参数,取值:ListNodes
RegionId String - 地域 ID。
ClusterId String - 集群 ID。
Role String - 节点角色,可选项包括 Manager:管控节点,Login:跳板机,Compute:计算节点。
HostName String - 节点名称,支持模糊查询, 支持 MySQL 的正则表达式。
OnlyDetached Boolean false 是否仅查询不由 E-HPC 管理的节点信息。如果为true, 则仅返回不由 E-HPC 释放的节点(比如包月节点或者非 E-HPC 创建的节点)。
PageNumber Integer 1 显示的页码,起始值为 1。
PageSize Integer 10 每页显示的条数,1-50。

返回参数

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

名称 类型 描述
Nodes Array<NodeInfo> 节点信息数组。
TotalCount Integer 列表条目总数。
PageNumber Integer 当前页码。
PageSize Integer 本页条数。

其中,NodeInfo 结构包含以下字段:

名称 类型 描述
Id String 节点实例 ID。
RegionId String 地域 ID。
Status String 节点状态。
CreateByEhpc Boolean 是否由 E-HPC 创建,目前都是。
Role String 节点类别,Scheduler:主调度器,SchedulerBackup:备用调度器,Account:主域服务器,AccountBackup:备用域服务器,Login:跳板机,Compute:计算节点。调度器和域服务器都属于管控节点(Manager)。
Roles Array
TotalResources ResourceType 资源总量。
UsedResources ResourceType 计算节点资源使用量,其他类型节点返回值为空。
AddTime Date 加入集群时间。
SpotStrategy String 后付费实例的竞价策略。
LockReason String 节点被锁定类型,默认返回为空字符串。
ExpiredTime Date 包月节点到期时间。如果节点是按量节点,则此项为空。
Expired Boolean 包月节点是否到期。如果节点是按量节点,则为false
ImageOwnerAlias String 镜像类型,systemselfothersmarketplace
ImageId String 镜像 ID。
Location String 节点所在位置,是本地节点 OnPremise 还是公共云上节点 PublicCloud
CreateMode String 节点是如何创建的,manual 手动扩容, autoscale 自动扩容

其中,计算节点资源 ResourceType 结构包含以下字段:

名称 类型 描述
Cpu Integer CPU资源总量,单位:核。
Memory Integer 内存资源总量,单位:GB。
Gpu Integer GPU资源总量,单位:卡。

节点状态 Status 的可能取值:

取值 描述
uninit 未初始化
init 初始化中
ready 空闲
running 运行中
exception 异常

示例

请求示例

  1. https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListNodes&RegionId=cn-shanghai&ClusterId=<集群ID>&<公共请求参数>

返回示例

XML格式

  1. <ListNodesResponse>
  2. <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>1</PageSize>
  6. <Nodes>
  7. <NodeInfo>
  8. <Id>i-uf68t1zu3jkhs8wyxhil</Id>
  9. <RegionId>cn-shanghai</RegionId>
  10. <Status>running</Status>
  11. <AddTime>2018-05-28T02:59:44.000Z</AddTime>
  12. <Expired>false </Expired>
  13. <SpotStrategy>NoSpot</SpotStrategy>
  14. <LockReason></LockReason>
  15. <ImageOwnerAlias>system</ImageOwnerAlias>
  16. <ImageId>centos_7_02_64_20G_alibase_20170818.vhd</ImageId>
  17. <Location>public_cloud</Location>
  18. <Roles>
  19. <Role>Compute</Role>
  20. </Roles>
  21. <TotalResources>
  22. <Cpu>2</Cpu>
  23. <Memory>4096</Memory>
  24. <Gpu>0</Gpu>
  25. </TotalResources>
  26. <UsedResources>
  27. <Cpu>0</Cpu>
  28. <Memory>0</Memory>
  29. <Gpu>0</Gpu>
  30. </UsedResources>
  31. </NodeInfo>
  32. </Nodes>
  33. </ListNodesResponse>

JSON格式

  1. {
  2. "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
  3. "TotalCount": 1,
  4. "PageNumber": 1,
  5. "PageSize": 1,
  6. "Nodes": {
  7. "NodeInfo" : [
  8. {
  9. "Id": "i-uf68t1zu3jkhs8wyxhil",
  10. "RegionId": "cn-shanghai",
  11. "Status": "running",
  12. "AddTime": "2018-05-28T02:59:44.000Z",
  13. "Expired": false,
  14. "SpotStrategy": "NoSpot",
  15. "LockReason": "",
  16. "ImageOwnerAlias": "system",
  17. "ImageId": "centos_7_02_64_20G_alibase_20170818.vhd",
  18. "Location": "public_cloud",
  19. "TotalResources": {
  20. "Cpu": 2,
  21. "Memory": 4096,
  22. "Gpu": 0
  23. },
  24. "UsedResources": {
  25. "Cpu": 0,
  26. "Memory": 0,
  27. "Gpu": 0
  28. }
  29. }
  30. ]
  31. }
  32. }

错误码

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