列举集群节点
列举资源组节点信息。
接口约束
无
URI
GET /v4/cwai/node/list
路径参数
无
Query参数
名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域唯一ID | 81f7728662dd11ec810800155d307d5b | |
status | 否 | String | 资源组状态,按照资源组运行状态进行过滤,默认为所有状态,取值: creating:资源组创建中 running:资源组运行中 failedCreate:资源组创建失败 deleted:资源组已删除 failedDelete:资源组删除失败 |
running | |
sortKey | 否 | String | 用于排序的列名,默认按照创建时间排序 | azName | |
sortType | 否 | String | 排序顺序,默认为倒序 | desc | |
nameLike | 否 | String | 用于检索实例名称的字符串模式 | %-worker | |
groupIDLike | 否 | String | 用于检索资源组ID的字符串模式 | asdfdd44% | |
pageNum | 否 | Integer | 页号,默认为1 | 1 | |
pageSize | 否 | Integer | 每一页的大小,默认为10 | 10 | |
isk8s | 否 | String | 区分IaaS和PaaS资源组参数,true为PaaS资源组,false为IaaS资源组 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域的唯一ID | xxx-xxx-yyyzzz |
请求体body参数
无
响应参数
名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 请求成功(800)或者失败(900) | 800 | |
errorCode | 是 | String | 错误代码 | cbi.api.console.xxxx | |
message | 是 | String | 错误信息的英文描述 | Invalid Request | |
returnObj | 是 | Object | 返回的集群信息 | returnObj |
表returnObj
名称 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalCount | 是 | Integer | 符合条件的资源组总数 | 10 | |
totalPage | 是 | Integer | 总页数 | 1 | |
currentCount | 是 | Integer | 本次查询返回的资源组个数 | 10 | |
result | 是 | Array of Objects | 返回的节点详情 | result |
表result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
resourceGroupName | 是 | String | 资源组名称 | testgroup | |
resourceGroupID | 是 | String | 资源组唯一ID | asdfdd44-3a45-11ee-b1cf-525400c96778 | |
InstanceUUID | 是 | String | 实例uuid | 2b11eb4f-084a-8c03-35f5-37c00aa7cfa1 | |
isK8s | 是 | Boolean | 是否k8s纳管节点 | true | |
deviceType | 是 | String | 资源组节点类型 | ecs.c5.xlarge | |
NodeType | 是 | String | 节点类型,取值范围: [ECS=云主机, EBM=裸金属] | ECS | |
instanceName | 是 | String | 实例名称 | cbi-master | |
status | 是 | String | 集群节点状态 | running | |
isMaster | 是 | Boolean | 是否是master节点 | true | |
memory | 是 | Integer | 内存大小(GB) | 8 | |
gpu | 是 | Integer | GPU数量 | 8 | |
cpu | 是 | Integer | CPU数量 | 4 | |
CpuSocket | 是 | Integer | CPU 槽数量 | 2 | |
CpuThreadAmount | 是 | Integer | CPU 线程数量 | 4 | |
CpuAmount | 是 | Integer | CPU 物理核数量 | 8 | |
gpuProduct | 是 | String | GPU型号 | NVIDIA-A800 | |
AzName | 是 | String | 可用区名称 | az1 |
请求示例
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/node/list?regionID=81f7728662dd11ec810800155d307d5b&pageSize=50&pageNum=1
Content-Type:application/json
regionID:81f7728662dd11ec810800155d307d5b
请求体body
无
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"result": [
{
"resourceGroupID": "f111c371-0983-411b-b351-fcae4b22cf2d",
"resourceGroupName": "a100-ecs-paas1",
"isK8s": true,
"instanceUUID": "b44bcb3d-25f3-60d6-11cc-26943ce1e2d2",
"deviceType": "p8a.6xlarge.4",
"nodeType": "ECS",
"instanceName": "gpu-a100-02",
"hostname": "gpu-a100-02",
"status": "onboarding",
"isMaster": false,
"memory": 98304,
"gpu": 1,
"cpu": 8,
"cpuAmount": 24,
"cpuThreadAmount": 0,
"cpuSocket": 0,
"gpuProduct": "NVIDIA-A100-SXM4-40GB",
"azName": "az3"
},
]
}
}
status参数取值列表
序号 | status | 说明 |
---|---|---|
1 | CREATING | 裸金属创建中 |
2 | STARTING | 裸金属启动中 |
3 | RUNNING | 裸金属运行中 |
4 | STOPPING | 裸金属关机中 |
5 | STOPPED | 裸金属已关机 |
6 | RESTARTING | 裸金属重启中 |
7 | ERROR | 裸金属故障中 |
8 | REINSTALLING | 裸金属重装系统中 |
9 | MAINTAINING | 裸金属维护中 |
10 | RESETTING_PASSWORD | 裸金属重置密码中 |
11 | DELETE | 裸金属删除 |
12 | ADDACH_VOLUME_IN_RUNNING | 裸金属运行状态挂载卷中 |
13 | DETACH_VOLUME_IN_RUNNING | 裸金属运行状态卸载卷中 |
14 | ADDACH_VOLUME_IN_STOPPED | 裸金属关机状态挂载卷中 |
15 | DETACH_VOLUME_IN_STOPPED | 裸金属关机状态卸载卷中 |
16 | ADDING_NETWORK | 裸金属添加网卡中 |
17 | DELETING_NETWORK | 裸金属删除网卡中 |
18 | TRANSFERING | 裸金属迁移中 |
19 | EXPORT_IMAGE | 裸金属导出镜像中 |
20 | MODIFY_NETWORK | 裸金属重置网络中 |
21 | RESETTING_HOSTNAME | 裸金属重置hostname中 |
22 | backuping | 云主机备份中 |
23 | creating | 云主机创建中 |
24 | expired | 云主机已到期 |
25 | freezing | 云主机冻结中 |
26 | rebuild | 云主机重装 |
27 | restarting | 云主机重启中 |
28 | running | 云主机运行中 |
29 | starting | 云主机开机中 |
30 | stopped | 云主机已关机 |
31 | stopping | 云主机关机中 |
32 | error | 云主机错误 |
33 | snapshotting | 云主机快照创建中 |
34 | onboarding | k8s纳管中 |
35 | onboarded | k8s已纳管 |
36 | onboard failed | k8s纳管失败 |
37 | deleting | 删除中 |
38 | deletefail | 删除失败 |