接口功能介绍
根据资源池ID、集群UUID查询节点列表信息。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
分页查询:当前查询结果以分页形式进行展示,单次查询最多显示1000条数据
匹配查找:可以通过部分字段进行匹配筛选数据,无符合条件的为空
接口约束
无
URI
GET /v4/cthpc/list-node
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 查询支持超算的地域列表 |
8e3a382e241d11ed957c0242ac110006 | |
clusterUUID | 是 | String | 节点所属集群UUID 获取: 查 查询集群列表 创 创建集群 |
cl-zhqloubcsmycabomouuuwhgahwit | |
nodeUUIDList | 否 | String | 节点UUID, 多个以逗号分隔, 多个以逗号分隔,如有nodeNameList则取交集 | uuid-1,uuid-2 | |
nodeNameList | 否 | String | 节点名称,多个以逗号分隔,如有nodeUUIDList则取交集 | name-1,name-2 | |
pageNo | 否 | Integer | 页码,取值范围:正整数(≥1),注:默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1, 1000],默认值:10,单页最大记录不超过1000 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
errorCode | String | 错误码,为product.module.code 三段式码 | Hpc.Node.NotValid | |
error | String | 错误码,为product.module.code 三段式码 | Hpc.Node.NotValid | |
message | String | 失败时的英文错误描述 | Param is null | |
description | String | 失败时的中文错误描述 | 请求为空 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 2 | |
totalCount | Integer | 总记录数 | 2 | |
totalPage | Integer | 总页数 | 1 | |
resultList | Array of Objects | 分页明细,元素类型是result,定义请参考result对象结构 | result |
表 result
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
nodeName | String | 节点名称 | PLATFORM-master-001 | |
nodeUUID | String | 节点实例UUID | nd-bjuoo8gvfkirbmrrq8yacgi4uckk | |
nodeRole | Integer | 节点角色, 取值范围如下: 0: master 1: compute |
0 | |
nodeType | Integer | 节点类型,目前只能是0: bm(裸金属服务器) | 0 | |
resourceInstanceUUID | String | 节点资源实例UUID, 如裸机实例UUID | ss-3ar4cglwj1h7hfy0hoctq5ofwixz | |
orderResourceID | String | 订单资源ID | 45c87ce1ede746fd8a1e0737de4436e5 | |
nodeSchedulerStatus | String | 调度器状态,取值范围如下: none:未开始采集节点状态的初始状态 allocated:节点资源已占满 completing:节点作业正在完成中 down:节点宕机 drain:节点已下线 fail:节点失效 failing:节点失效中 future:节点未来可用 idle:节点空闲 maint:节点维护中 mixed:节点部分使用 perfctrs/npc:节点无法使用,因网络计数器使用中 reserved:节点被预留 power_down:节点正在关机 power_up:节点正在开机 resume:节点恢复中 undrain:节点上线中 unknown:节点状态未知 |
idle | |
nodeStatus | String | 节点所在物理机的状态,取值范围如下: CREATING:创建中 STARTING:启动中 RUNNING:运行中 STOPPING:关机中 STOPPED:已关机 RESTARTING:重启中 ERROR:故障中 REINSTALLING:重装系统中 RESETTING_PASSWORD:重置密码中 DESTROYING:销毁中 UPDATE_SECURITY_GROUP:更新安全组 ADDING_NETWORK:添加网络中 DELETEING_NETWORK:删除网络中 |
RUNNING | |
cpuLoad | Float | cpu负载 | 1.5 | |
innerIP | String | 节点的内网IP | 192.168.0.81 | |
publicIP | String | 节点的公网IP(即弹性IP) | 100.127.6.203 | |
cpuQuantity | Integer | cpu核数 | 32 | |
nodeMemory | Integer | 内存大小 MB | 1024 | |
createTime | String | 创建时间 | 2022-10-27 12:40:06 |
枚举参数
无
请求示例
请求url
示例:查询内蒙6资源池某个集群的节点列表
/v4/cthpc/list-node?regionID=6019b5007a0b11eab5db0242ac110002&clusterUUID=cl-zhqloubcsmycabomouuuwhgahwit
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"resultList": [
{
"cpuLoad": 1.5,
"nodeSchedulerStatus": "none",
"resourceInstanceUUID": "ss-3ar4cglwj1h7hfy0hoctq5ofwixz",
"nodeName": "PLATFORM-master-001",
"orderResourceID": "45c87ce1ede746fd8a1e0737de4436e5",
"nodeMemory": 1024,
"createTime": "2022-10-27 12:40:06",
"cpuQuantity": 32,
"nodeRole": 0,
"publicIP": "100.127.6.203",
"innerIP": "192.168.0.81",
"nodeType": 0,
"nodeStatus": "RUNNING",
"nodeUUID": "nd-bjuoo8gvfkirbmrrq8yacgi4uckk"
},
{
"cpuLoad": 1.5,
"nodeSchedulerStatus": "none",
"resourceInstanceUUID": "ss-y5h6oyitmszgfltsib9vpzfuubo7",
"nodeName": "PLATFORM-compute-001",
"orderResourceID": "45c87ce1ede746fd8a1e0737de4436e5",
"nodeMemory": 1024,
"createTime": "2022-10-27 12:40:04",
"cpuQuantity": 32,
"nodeRole": 1,
"publicIP": "100.127.4.119",
"innerIP": "192.168.0.143",
"nodeType": 0,
"nodeStatus": "RUNNING",
"nodeUUID": "nd-gwtwhjic9fsmvehrkq5d1znau3xl"
}
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码