接口功能介绍
获取队列信息列表
接口约束
华北2
URI
POST /v4/cwai/central/task-service/queue/queue-info-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | ||
| pageSize | 否 | Integer | 每页的数目 | ||
| regionID | 是 | String | 资源池ID，regionID不能为空 | ||
| resourceGroupID | 否 | String | 资源组ID | ||
| status | 否 | String | 状态筛选 | ||
| workspaceIDs | 否 | Array of Strings | 工作空间ID | ||
| isDesc | 否 | Boolean | 是否按创建时间倒序返回 | ||
| name | 否 | String | 队列名 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 本次查询返回的数据个数 | 10 | |
| result | Array of Objects | 返回的队列配额信息详情 | result | |
| totalCount | Integer | 符合条件的队列配额信息总数 | 10 | |
| totalPage | Integer | 总页数 | 1 |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 名称 | ||
| queueID | String | 队列ID | ||
| regionID | String | 区域的唯一ID | ||
| azName | String | azName | ||
| resourceGroupID | String | 资源组ID | ||
| resourceGroupName | String | 资源组名称 | ||
| queueQuota | Array of Objects | 队列规格使用详情 | queueQuota | |
| createTime | String | 创建时间 | ||
| workspaceID | String | 工作空间ID | ||
| workspaceName | String | 工作空间名称 | ||
| status | String | 状态 |
表 queueQuota
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| queueDeviceName | String | 规格名称 | ||
| queueDeviceID | String | 设备ID | ||
| statusMsg | String | 状态 | ||
| gpuResourceName | String | GPU资源名称 | ||
| cpu | Integer | 总规格：cpu | ||
| memory | Integer | 总规格：内存 | ||
| gpu | Integer | 总规格：gpu | ||
| allocatedCpu | Integer | 已使用：cpu | ||
| allocatedMemory | Integer | 已使用：内存 | ||
| allocatedGpu | Integer | 已使用：gpu | ||
| allocatedCpuRatio | Float | 已使用：cpu | ||
| allocatedMemoryRatio | Float | 已使用：内存 | ||
| allocatedGpuRatio | Float | 已使用：gpu | ||
| gpuName | Integer | GPU名称 | ||
| count | Integer | 规格单位个数 | ||
| nodeKey | String | 节点键值 |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/queue/queue-info-list
Content-Type:application/json
请求头header
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
{
"isDesc": true,
"name": "xx",
"pageNo": 1,
"pageSize": 10,
"regionID": "200000001852",
"resourceGroupID": "49f62db9-810c-4a11-a731-702dc29c9790",
"status": "running",
"workspaceIDs": [
"29d1f124-dcb4-4fd7-a2c6-606db6827536"
]
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"result": [{
"name": "queue01",
"queueID": "5c512e73-953a-49ce-be88-fdf70dc5f5fd",
"creator": "秦焕焕",
"createUserID": "8bf87c66cc0b40f4afc54950e82c5b46",
"regionID": "200000001852",
"azName": "cn-huabei2-tj1A-public-ctcloud",
"resourceGroupID": "49f62db9-810c-4a11-a731-702dc29c9790",
"resourceGroupName": "wuchengcheng",
"workspaceID": "29d1f124-dcb4-4fd7-a2c6-606db6827536",
"workspaceName": "",
"queueQuota": [{
"queueDeviceID": "9b1eb5ea-bc98-41c7-a583-eb7bd10854bf",
"queueDeviceName": "huawei-Ascend910 2卡 48C 384G",
"cpu": 144,
"memory": 1152,
"gpu": 6,
"allocatedCpu": 144,
"allocatedMemory": 1152,
"allocatedGpu": 6,
"gpuName": "huawei-Ascend910",
"count": 3,
"allocatedCount": 3,
"statusMsg": "",
"gpuResourceName": "huawei.com/Ascend910",
"nodeKey": "accelerator",
"allocatedCpuRatio": 1,
"allocatedMemoryRatio": 1,
"allocatedGpuRatio": 1
}],
"status": "running"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
