接口功能介绍
展示节点列表信息
接口约束
华北2
URI
POST /v4/cwai/central/resource-group-service/node/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageSize | 否 | Integer | 页大小 | 10 | |
| pageNum | 否 | Integer | 页码 | 1 | |
| regionID | 是 | String | 区域ID | nm8 | |
| nameLike | 否 | String | 节点名称模糊查询 | asd | |
| resourceGroupID | 否 | String | 资源组ID查询 | 547eb31e-20a7-474f-8f15-7da9f89d147b | |
| sortType | 否 | String | 排序方式(默认降序) | ascend | |
| sortKey | 否 | String | 用于排序的Key(默认按照创建时间排序) | created_at | |
| groupType | 否 | String | 资源组类型 | PAAS | |
| status | 否 | String | 节点状态过滤参数[NotReady,Ready] | Ready | |
| k8sStatus | 否 | Array of Strings | 节点K8s状态过滤参数[支持多选，需和status搭配使用],[Ready,NotReady] | Ready | |
| nodeType | 否 | Array of Strings | 节点类型过滤参数[支持多选] [ECS,EBM] | EBM | |
| gpuType | 否 | Array of Strings | 节点GPU类型过滤参数[支持多选] [Nvidia,Huawei] | Huawei | |
| createUserID | 否 | String | 创建者ID | ||
| isLocked | 否 | String | 区分锁定、解锁 | true | |
| isUnbound | 否 | Boolean | 区分未绑定页面 | true | |
| id | 否 | String | 按节点ID查询 | 121314ef-22a7-4356-6g34-2f5hf89d144c |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900)，是否必填：是 | 800 | |
| error | String | 错误代码，是否必填：否 | Cwai.Node.xxxx | |
| returnObj | Object | 返回节点列表的信息，是否必填：是 | returnObj | |
| message | String | 错误信息的描述，是否必填：否 | 请求字段错误 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页数目，是否必填：是 | 1 | |
| totalCount | Integer | 总数目，是否必填：是 | 50 | |
| totalPage | Integer | 总页数，是否必填：是 | 5 | |
| result | Object | 列表，是否必填：是 | [] | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 节点ID，是否必填：是 | 121314ef-22a7-4356-6g34-2f5hf89d144c | |
| resourceGroupID | String | 资源组ID，是否必填：是 | 547eb31e-20a7-474f-8f15-7da9f89d147b | |
| resourceGroupName | String | 资源组名称，是否必填：是 | test1 | |
| instanceUUID | String | 物理机uuid，是否必填：是 | ss-1uj51pdschdsnudp7dpsgbx5i9qu | |
| instanceName | String | 物理机名称，是否必填：是 | new-node-2 | |
| deviceType | String | 物理机套餐类型，是否必填：是 | physical.t17.large | |
| status | String | 节点状态，是否必填：是 | Ready | |
| memory | Integer | 内存大小，是否必填：是 | 2400 | |
| gpu | Integer | gpu数量，是否必填：是 | 8 | |
| cpu | Integer | cpu数量，是否必填：是 | 128 | |
| cpuAmount | Integer | 单个cpu核数，是否必填：是 | 32 | |
| cpuSockets | Integer | 物理cpu数量，是否必填：是 | 2 | |
| cpuThreadAmount | Integer | 单个物理cpu超线程数量，是否必填：是 | 64 | |
| gpuProduct | String | gpu型号，是否必填：是 | NVIDIA-A100-SXM4-40GB | |
| isLocked | Boolean | 节点是否锁定，是否必填：是 | false | |
| podNum | Integer | 节点中pod的数量，是否必填：是 | 0 |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/resource-group-service/node/list
Content-Type:application/json
{
"regionID": "200000001852",
"pageNo": 1,
"pageSize": 10,
"nameLike": "",
"resourceGroupID": "",
"groupType":"PAAS",
"isUnbound": false
}
请求头header
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
{
"regionID": "200000001852",
"pageNo": 1,
"pageSize": 10,
"nameLike": "",
"resourceGroupID": "",
"groupType":"PAAS",
"isUnbound": false
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"result": [
{
"id": "121314ef-22a7-4356-6g34-2f5hf89d144c",
"resourceGroupID": "12345678-b6ee-4c6f-8d69-e26e2e073b2c",
"resourceGroupName": "test1130",
"instanceUUID": "ss-1753jfuschdsn7dpsgbx5i9qu",
"instanceName": "new",
"deviceType": "physical.t17.large",
"status": "Ready",
"memory": 240000,
"gpu": 8,
"cpu": 2800,
"gpuProduct": "NVIDIA-A100-SXM4-40GB",
"isLocked": false,
"podNum": 0,
"cpuAmount": 32,
"cpuSockets": 2,
"cpuThreadAmount": 64
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
