查询任务列表
接口功能介绍
列举已经创建的所有的任务。
URI
GET /v4/cwai/job/list
Query参数
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
queueID |
否 |
String |
队列唯一ID |
d0dc8ddc8e3e11eca6200242bd110004 |
|
pageSize |
否 |
String |
页大小 |
10 |
|
pageNo |
否 |
String |
页号 |
1 |
|
sortKey |
否 |
String |
排序字段名称 |
resourceGroupID |
|
sortType |
否 |
String |
排序类型 |
descend |
|
nameLike |
否 |
String |
模糊查询字段名称 |
|
|
regionID |
是 |
String |
区域的唯一ID |
xxx-xxx-yyyzzz |
|
请求参数
Header请求参数
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
userID |
否 |
String |
用户ID |
c82cca09-xxx-kf24eaad21 |
|
accountID |
否 |
String |
账户ID |
e9023c081-xxx-ffae4d |
|
Body请求参数
无
响应参数
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
statusCode |
是 |
Integer |
请求成功(800)或者失败(900) |
800 |
|
errorCode |
否 |
String |
错误代码 |
cce.api.console.xxxx |
|
message |
否 |
String |
错误信息的描述 |
Invalid Request |
|
returnObj |
否 |
Object |
返回资源组信息列表 |
|
returnObj |
表returnObj
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
currentCount |
是 |
Integer |
当前页展示任务数目 |
1 |
|
totalCount |
是 |
Integer |
总数目 |
1 |
|
totalPage |
是 |
Integer |
总页数 |
1 |
|
result |
是 |
Object |
名称 |
[] |
result |
表result
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
name |
是 |
|
名称 |
|
|
jobID |
是 |
String |
任务ID |
job-419c7XXX3f2b4f58e |
|
resourceGroupID |
是 |
String |
资源组ID |
d0dc8ddc8e3e11eca6200242bd110004 |
|
resourceGroupName |
是 |
String |
资源组名称 |
resource_group_test |
|
queueID |
是 |
String |
队列ID |
2huidhcdu3qhwguidgqwguwehfcweg87 |
|
queueName |
是 |
String |
队列名称 |
queue_test |
|
queueName |
是 |
String |
队列名称 |
queue_test |
|
trainType |
是 |
String |
训练类型 |
DDP |
|
trainFrame |
是 |
String |
训练框架 |
Pytorch |
|
datasets |
是 |
String |
数据集 |
|
|
replicas |
是 |
Array of Objects |
实例个数 |
|
datasetInfo |
resources |
是 |
Integer |
单个实例资源 |
resources |
|
status |
是 |
Object |
状态 |
|
|
comment |
是 |
String |
备注 |
|
|
beginTime |
是 |
String |
创建时间 |
|
|
finishTime |
是 |
String |
结束时间 |
2023-08-22 10:57:10 |
|
表resources
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
cpuLimit |
是 |
String |
CPU限制 |
|
|
gpuLimit |
是 |
String |
GPU限制 |
|
|
memLimit |
是 |
String |
存储限制 |
|
|
hcaShared |
是 |
String |
共享HCA |
|
|
表datasetInfo
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
name |
是 |
String |
数据集名称 |
|
|
datasetID |
是 |
String |
数据集ID |
|
|
mountPath |
是 |
String |
挂载路径 |
|
|
示例
请求示例
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/job/list?queueID=d0dc8ddc8e3e11eca6200242ac110003
Content-Type:application/json
{
"userID": "c82cca09-xxx-kf24eaad21",
"accountID": "e9023c081-xxx-ffae4d",
}
正常返回示例
HTTP/1.1200 OK
Content-Type:application/json
{
"statusCode":800,
"returnObj":{
"currentCount":1,
"totalCount":1,
"totalPage":1,
"result":[
{
"name":"xuyy-train1305",
"jobID":"job-f16af262-20dc-4e87-8838-26517786b3ca",
"userID":"",
"resourceGroupID":"asdfdd44-3a45-11ee-b1cf-525400c96778",
"resourceGroupName":"",
"queueID":"5fe1e845-bc77-463c-9890-903e76185adf",
"queueName":"xuyy-queue-121",
"trainType":"DDP",
"trainFrame":"Pytorch",
"datasets":[
{
"name":"jy-dataset-cifar",
"datasetID":"zos-ca96490b-e97f-4422-9843-0d114da708c4",
"mountPath":"/opt/ml/input/data/xuyytest"
}
],
"replicas":1,
"resources":{
"cpuLimit":1,
"gpuLimit":1,
"memLimit":1,
"hcaShared":0
},
"comment":"",
"beginTime":"2023-10-13 11:22:01",
"finishTime":"",
"status":"Running"
}
]
}
}
错误参数返回示例
HTTP/1.1200 OK
Content-Type:application/json
{
"statusCode":900,
"errorCode":"Cwai.Api.BadRequest",
"message":"***",
}
内部服务错误返回示例
TTP/1.1200 OK
Content-Type:application/json
{
"statusCode":900,
"errorCode":"Cwai.Api.InternalServerError",
"message":"***",
}
状态码
错误码
错误码 |
描述 |
Cwai.Api.BadRequest |
错误请求 |
Cwai.Api.NotFound |
资源不存在 |
Cwai.Api.StatusUnauthorized |
状态未授权 |
Cwai.Api.InternalServerError |
内部错误 |