查询队列列表
接口功能介绍
列举已经创建的所有的队列。
URI
GET /v4/cwai/queue/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域唯一ID | 81f7728662dd11ec810800155d307d5b | |
resourceGroupID | 否 | String | 资源组唯一ID | asdfdd44-3a45-11ee-b1cf-525400c96778 | |
sortKey | 否 | String | 用于排序的key | queueType | |
sortType | 否 | String | 排序顺序,默认为按照创建时间倒序排列 | descend | |
nameLike | 否 | String | 用于检索队列名称的字符串模式 | demo | |
queueIDLike | 否 | String | 用于检索队列ID的字符串模式 | asdfdd44 | |
pageNo | 否 | Integer | 页号 | 1 | |
pageSize | 否 | Integer | 每一页的大小 | 10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
userID | 是 | String | 用户ID | 8a122a-xxx-f34d13e73 | |
regionID | 是 | String | 区域的唯一ID | xxx-xxx-yyyzzz |
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 请求成功(800)或者失败(900) | 800 | |
errorCode | 是 | String | 错误代码 | Cwai.Api.xxxx | |
message | 是 | String | 错误信息的英文描述 | Invalid Request | |
returnObj | 是 | Object | 返回队列信息列表 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
totalCount | 是 | Integer | 队列总数 | 54 | |
totalPage | 是 | Integer | 总页数 | 6 | |
currentCount | 是 | Integer | 当前页队列个数 | 4 | |
result | 是 | Array | 队列详情列表 | result |
表result
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
resourceGroupID | 是 | String | 资源组唯一ID | d0dc8ddc8e3e11eca6200242ac110003 | |
queueName | 是 | String | 队列名称 | job-demo | |
queueID | 是 | String | 队列唯一ID | f46388253705401e9c8bd2c96a1ac4ec | |
comment | 是 | String | 队列描述 | xxxx | |
createTime | 是 | Integer | 队列创建时间 | 2006-01-02 15:04:05.999999999 -0700 MST | |
queueType | 是 | String | 队列最小规格单位 | A1008C128G1卡 | |
count | 是 | String | 队列含单位规格个数 | 10 | |
cpu | 是 | Integer | 该队列的CPU配额 | 64 | |
memory | 是 | Integer | 该队列的内存配额 | 128G | |
gpu | 是 | Integer | 该队列的GPU卡数配额 | 16 | |
status | 是 | String | 队列状态 | Running | |
jobNums | 是 | Integer | 该队列关联的总任务数 | 8 |
请求示例
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/queue/list?regionID=d0dc8ddc8e3e11eca6200242ac110003
Content-Type:application/json
regionID:81f7728662dd11ec810800155d307d5b
请求头header
{
"userID":"8a122a-xxx-f34d13e73"
}
请求体body
无
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"returnObj": {
"totalCount":4,
"totalPage":4,
"currentCount":1,
"result:[
{
"resourceGroupID": "asdfdd44-3a45-11ee-b1cf-525400c96778",
"resourceGroupName": "testGroup",
"regionID": "81f7728662dd11ec810848575d307d5b",
"queueID": "f46388253705401e9c8bd2c96a1ac4ec",
"queueType": "NVIDIA-A100-SXM4-40GB 2卡 2C 2G",
"name": "queue-demo",
"createTime: "2006-01-02 15:04:05.999999999 -0700 MST",
"count": 10,
"cpu" : "64",
"memory": 1280,
"gpu": 16,
"jobNum": 5,
"status": "running",
"comment": "ahhhthis is huiguiceshi" }
]
}
}
错误参数返回示例
HTTP/1.1200 OK
Content-Type:application/json
{
"statusCode":900,
"errorCode":"Cwai.Api.BadRequest",
"message":"***",
}
内部服务错误返回示例
HTTP/1.1200 OK
Content-Type:application/json
{
"statusCode":900,
"errorCode":"Cwai.Api.InternalServerError",
"message":"***",
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Cwai.Api.BadRequest | 错误请求 |
Cwai.Api.NotFound | 资源不存在 |
Cwai.Api.StatusUnauthorized | 状态未授权 |
Cwai.Api.InternalServerError | 内部错误 |