查询任务详情
接口功能介绍
根据任务ID查看具体任务信息。
接口约束
无
URI
GET /v4/cwai/job/{jobID}
Query请求参数
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
jobID |
否 |
String |
任务ID |
job-419c7XXX3f2b4f58e |
|
regionID |
是 |
String |
区域的唯一ID |
xxx-xxx-yyyzzz |
|
请求参数
Header请求参数
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
userID |
否 |
String |
用户ID |
41bb284-xxx-283dd1 |
|
accountID |
否 |
String |
账户ID |
e9023c081-xxx-1affae4d |
|
Body请求参数
无
返回数据
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
statusCode |
是 |
Integer |
请求成功(800)或者失败(900) |
800 |
|
errorCode |
否 |
String |
错误代码 |
cce.api.console.xxxx |
|
message |
否 |
String |
错误信息的描述 |
Invalid Request |
|
returnObj |
否 |
Object |
返回资源组信息 |
{} |
returnObj |
returnObj元素参数定义
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
name |
是 |
String |
名称 |
job-test |
|
jobID |
是 |
String |
jobID |
81f7728662dd11ec810800155d307d5b |
|
userID |
是 |
String |
用户ID |
41bb284-xxx-283dd1 |
|
accountID |
是 |
String |
账户ID |
e9023c081-xxx-1affae4d |
|
regionID |
是 |
String |
区域ID |
73f321ea-62ff-11ec-a8bc-005056898fe0 |
|
azName |
是 |
String |
可用区名称 |
az1 |
|
resourceGroupID |
是 |
String |
资源组ID |
d0dc8ddc8e3e11eca6200242bd110004 |
|
queueID |
是 |
String |
队列ID |
2huidhcdu3qhwguidgqwguwehfcweg87 |
|
queueName |
是 |
String |
队列名称 |
queue_test |
|
trainType |
是 |
String |
训练类型 |
DDP |
|
trainFrame |
是 |
String |
训练框架 |
Pytorch |
|
jobOperator |
是 |
String |
job操作器 |
|
|
isDeepspeed |
是 |
Boolean |
是否开启deepspeed |
true |
|
datasets |
是 |
Array of Objects |
数据集 |
|
datasetInfo |
imageName |
是 |
String |
镜像名称 |
image_test |
|
imageVersion |
是 |
String |
镜像版本 |
v0.1 |
|
command |
是 |
Array of Strings |
指令 |
|
|
envs |
是 |
Array of Objects |
环境 |
|
envs |
replicas |
是 |
Integer32 |
复制品 |
12 |
|
resources |
是 |
Object |
资源 |
|
resources |
output |
是 |
Object |
输出 |
|
output |
logOutput |
是 |
Object |
日志输出 |
|
output |
pods |
是 |
Object |
实例信息 |
|
pod |
status |
是 |
String |
状态 |
|
|
comment |
是 |
String |
描述 |
|
|
createTime |
是 |
String |
创建时间 |
2006-01-02 15:04:05 |
|
finishTime |
是 |
String |
结束时间 |
2023-08-22 11:57:10 |
|
datasetInfo
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
name |
是 |
String |
数据集名称 |
|
|
datasetID |
是 |
String |
数据集ID |
|
|
mountPath |
是 |
String |
挂载路径 |
|
|
表resources
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
cpuLimit |
是 |
String |
CPU限制 |
|
|
gpuLimit |
是 |
String |
GPU限制 |
|
|
memLimit |
是 |
String |
存储限制 |
|
|
hcaShared |
是 |
String |
共享HCA |
|
|
表envs
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
name |
是 |
String |
名称 |
|
|
value |
是 |
String |
值 |
|
|
表output
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
storageType |
是 |
String |
存储类型 |
|
|
zosBucket |
是 |
String |
zos桶 |
|
|
zosEndpoint |
是 |
String |
zos endpoint |
|
|
accessKeyID |
是 |
String |
用户ak |
|
|
accessKeySecret |
是 |
String |
用户sk |
|
|
mountDir |
是 |
String |
挂载磁盘 |
|
|
sfsUUID |
是 |
String |
sfs的uuid |
|
|
hpfsID |
是 |
String |
ceph底层的id |
|
|
sfsSize |
是 |
String |
sfs大小 |
|
|
hpfsSharePath |
是 |
String |
hpfs 文件系统共享路径 |
|
|
pvcName |
是 |
String |
pvc名称 |
|
|
表pod
参数 |
是否必填 |
参数类型 |
说明 |
示例值 |
下级对象 |
role |
是 |
String |
角色 |
|
|
name |
是 |
String |
名称 |
|
|
restartCount |
是 |
Integer |
重启次数 |
|
|
podIP |
是 |
String |
ip |
|
|
hostIP |
是 |
String |
节点ip |
|
|
containerNames |
是 |
[]String |
容器名称 |
|
|
startTime |
是 |
String |
启动时间 |
|
|
finishTime |
是 |
String |
结束时间 |
|
|
status |
是 |
String |
状态 |
|
|
示例
请求示例
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/job/jobID=81f7728662dd11ec810800155d307d5b
Content-Type:application/json
regionID:81f7728662dd11ec810800155d307d5b
正常返回示例
HTTP/1.1200 OK
Content-Type:application/json
{
"statusCode":800,
"returnObj":{
"name":"xuyy-train1305",
"jobID":"job-f16af262-20dc-4e87-8838-26517786b3ca",
"userID":"41bb284-xxx-283dd1",
"accountID":"",
"regionID":"81f7728662dd11ec810800155d307d5b",
"azName":"",
"resourceGroupID":"asdfdd44-3a45-11ee-b1cf-525400c96778",
"resourceGroupName":"",
"queueID":"5fe1e845-bc77-463c-9890-903e76185adf",
"queueName":"xuyy-queue-121",
"trainType":"DDP",
"trainFrame":"Pytorch",
"jobOperator":"kubeflow",
"isDeepspeed":false,
"datasets":[
{
"name":"jy-dataset-cifar",
"datasetID":"zos-ca96490b-e97f-4422-9843-0d114da708c4",
"mountPath":"/opt/ml/input/data/xuyytest"
}
],
"imageName":"cwai.ccr.ctyun.cn:5000/41bb284c9b1b4256a49ecd58dd283dd1/minist-cpu",
"imageVersion":"v3",
"command":[
"/bin/sh",
"-c",
"cd /root/samples && python minist_tensorboard.py --data_dir /opt/ml/input/data/xuyytest --max_steps 100 2>&1 | tee /opt/ml/log/output1305.log && sleep 1200"
],
"envs":[
{
"name":"name1",
"value":"value1"
},
{
"name":"name2",
"value":"value2"
}
],
"replicas":1,
"resources":{
"cpuLimit":1,
"gpuLimit":1,
"memLimit":1,
"hcaShared":0
},
"output":{
"storageType":"ZOS",
"zosBucket":"xuyy-bucket1",
"zosEndpoint":"http://192.168.10.20",
"accessKeyID":"01UP-xxx-Z72",
"accessKeySecret":"qtyy8w-xxx-LOwW4",
"mountDir":"/train1/output",
"sfsUUID":"",
"hpfsID":"",
"sfsSize":"",
"hpfsSharePath":"",
"pvcName":"pvc-3d5e514e-5f25-476c-9763-9ad6219db358"
},
"logOutput":{
"storageType":"ZOS",
"zosBucket":"xuyy-bucket1",
"zosEndpoint":"http://192.168.10.20",
"accessKeyID":"01UP-xxx-Z72",
"accessKeySecret":"qtyy8w-xxx-LOwW4",
"mountDir":"/train1/tensorboard",
"sfsUUID":"",
"hpfsID":"",
"sfsSize":"",
"hpfsSharePath":"",
"pvcName":"pvc-a161ebf9-6a35-49d1-8505-a50e0aa6b0a6"
},
"comment":"",
"pods":[
{
"role":"worker",
"name":"job-f16af262-20dc-4e87-8838-26517786b3ca-worker-0",
"restartCount":0,
"podIP":"10.233.42.155",
"hostIP":"192.168.20.5",
"yaml":{
"metadata":{
"creationTimestamp":null
},
"spec":{
"containers":null
},
"status":{}
},
"containerNames":[
"pytorch"
],
"startTime":"2023-10-13 11:22:13",
"finishTime":"",
"status":"Running"
}
],
"status":"Running",
"createTime":"2023-10-13 11:22:01",
"finishTime":""
}
}
错误参数返回示例
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 |
内部错误 |