接口功能介绍
任务运行记录详情
接口约束
无
URI
GET /v4/cwai/central/task-service/taskrecord/get
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 否 | String | 区域的唯一ID | 81f7728662dd11ec810800155d307d5b | |
| id | 是 | String | 任务记录的ID | project-test |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| workspaceID | 是 | String | 工作空间ID | 1810e490-3c45-42a2-8428-08c50797e817 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900) | 800 | |
| errorCode | String | 错误代码 | Cwai.Api.xxxx | |
| message | String | 错误信息的英文描述 | Invalid Request | |
| returnObj | Object | 返回镜像的详细信息 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| name | String | 任务记录名称 | 246 | |
| taskRecordID | String | 任务记录ID | 162 | |
| taskID | String | 任务ID | ||
| queueID | String | 队列ID | 363 | |
| queueName | String | 队列名称 | v1 | |
| remark | String | 2024-01-12T06:48:04.117Z | 描述 | |
| trainFrame | String | 训练框架, 目前仅支持[Pytorch] | Pytorch | |
| trainMode | String | 训练模式, 目前仅支持[DDP] | DDP | |
| storages | Array of Objects | 存储定义 | sha256:40436c3f1d6b311f56a27692cdcf808ebabf9af86787213aaff61b439c48fe03 | storage |
| imageName | String | 镜像名称 | 2024-01-12T06:20:54.336Z | |
| commands | Array of Strings | 启动指令 | 21240352060 | |
| envs | Array of Objects | 环境变量 | cwai.ctyun.cn:15000/project-cwpublic/ubuntu18.04.6-torch2.0.1:v1 | env |
| resources | Array of Objects | 资源定义 | ubuntu18.04.6-torch2.0.1 | resource |
| creator | String | 创建者 | project-cwpublic | |
| status | Integer | 状态 [1(创建中,2(已创建),3(排队中),4(运行中),5(重启中),6(运行成功),7(运行失败),8(停止中),9(已停止),10(异常)] | 1 | |
| statusMsg | String | 状态信息 | ||
| statusName | String | 状态名称 [创建中,已创建,排队中,运行中,重启中,运行成功,运行失败,停止中,已停止,异常] | 创建中 | |
| enableTensorboard | Boolean | 是否打开tensorboard日志 | ||
| finishTime | String | 完成时间 | ||
| ifFailedRestart | Boolean | 是否失败后重启 | ||
| nodeLabels | Array of Strings | 指定标签进行节点调度 | ||
| operator | String | 创建人 | ||
| runTime | String | 启动时间 | ||
| scope | Integer | 可见范围 0 仅自己可见 1工作空间可见 | ||
| url | String | tensorboard打开链接 |
表 storage
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| storageID | String | 存储ID | 95d55c7f-6a88-4022-8d7f-e465c73d673d | |
| storageName | String | 存储名称 | masan-test | |
| podPath | String | pod挂载目录 | /data | |
| subPath | String | 数据集/数据源/模型子/本地目录 | /test | |
| type | String | 存储类型, 目前仅支持 [Dataset, DataSource, Model, Local] | DataSource |
表 env
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 环境变量名称 | a | |
| value | String | 环境变量值 | 5 |
表 resource
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| roleName | String | 角色名称, 有效值 [Master,Worker] | Worker | |
| queueNodeDeviceID | String | 队列节点设备ID | 6e719d9e-b912-44b0-aae7-59207f342ee9 | |
| replicas | Integer | 副本数 | 1 |
枚举参数
无
请求示例
请求url
GET https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/task-service/taskrecord/get?id=task-py-5456850f-4033-4eae-9d9c-ae3687941f0c
Content-Type:application/json
请求头header
workspaceID:1810e490-3c45-42a2-8428-08c50797e817
User-Agent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
无
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"name": "test7",
"queueID": "fc5842e7-c396-4c3e-b59b-f40c0fb64d80",
"queueName": "",
"trainFrame": "Pytorch",
"trainMode": "DDP",
"storages": [
{
"type": "DataSource",
"storageID": "4702ac7f-4c5c-43f0-9923-d7ad5fc2ab31",
"storageName": "",
"pvcName": "",
"subPath": "",
"podPath": "/data",
"usedType": 0,
"comment": ""
}
],
"imageName": "cbi.ccr.ctyun.cn:15000/project-cwpublic/chatglm2-6b:v2-DeepSpeed0.9.2-Pytorch1.11.0-cann7.0-Ubuntu22.04-arm64",
"commands": [
"jp1YmXDFfafCHwCUMekTQQ==",
"ecyD7LDN0rd1RpID+p8lpQ==",
"dKn97aZCx6t7fV82F5jaTQ=="
],
"envs": [
{
"name": "test ",
"value": "1"
},
{
"name": "test2",
"value": "2"
}
],
"resources": [
{
"queueNodeDeviceID": "8bd12065-f643-4dbe-8685-3bf82dc5b521",
"roleName": "Worker",
"replicas": 1
}
],
"scope": 0,
"enableTensorboard": false,
"creator": "41bb284c9b1b4256a49ecd58dd283dd1",
"taskID": "7206ed7e-6e9b-4258-b665-ae192ddff65f",
"taskRecordID": "task-py-5456850f-4033-4eae-9d9c-ae3687941f0c",
"status": 2,
"statusName": "已创建",
"statusMsg": "PyTorchJob task-py-5456850f-4033-4eae-9d9c-ae3687941f0c is created.",
"queueTime": "",
"runTime": "",
"finishTime": "2024-09-26 14:55:31",
"operator": "xxx@chinatelecom.cn",
"remark": "test",
"nodeLabels": [],
"url": "/user-service/455cce64-89ab-43dd-a984-97535ec5c339/tb/tensorboard-task-py-5456850f-4033-4eae-9d9c-ae3687941f0c/",
"ifFailedRestart": false
}
}
状态码
请参考 状态码
错误码
请参考 错误码
