接口功能介绍
创建任务
接口约束
华北2
URI
POST /v4/cwai/central/task-service/task/create-and-run
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| workspaceID | 是 | String | 工作空间ID | 1810e490-3c45-42a2-8428-08c50797e817 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 名称1~63个字符之间 | test1 | |
| regionID | 是 | String | 区域的唯一ID | 81f7728662dd11ec810800155d307d5b | |
| remark | 否 | String | 描述，没有字符限制 | test | |
| trainFrame | 是 | String | 训练框架，目前仅支持[Pytorch] | ||
| trainMode | 是 | String | 训练模式，目前仅支持[DDP] | ||
| queueID | 是 | String | 队列ID | c59496bc-51f3-4926-8e85-e3e719b91471 | |
| storages | 否 | Array of Objects | 存储相关，包括数据集等 | storage | |
| imageName | 是 | String | 镜像名称 版本信息 | cbi.ccr.ctyun.cn:5000/admin/megatron-deepspeed-llama2pretrain:v1 | |
| commands | 是 | Array of Strings | 启动指令, 该指令需要加密后再传输 | ||
| envs | 否 | Array of Objects | 环境变量 | env | |
| resources | 是 | Array of Objects | 资源配置 | resource |
表 storage
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| storageID | 是 | String | 存储ID | 95d55c7f-6a88-4022-8d7f-e465c73d673d | |
| storageName | 否 | String | 存储名称 | ||
| subPath | 否 | String | 数据集/数据源/模型子/本地目录 | ||
| type | 是 | String | 存储类型, 目前仅支持 [Dataset, DataSource, Model, Local] | DataSource | |
| podPath | 是 | String | pod挂载目录 | /data | |
| comment | 否 | String | 备注 | ||
| pvcName | 否 | String | 存储pvc | ||
| usedType | 否 | Integer | 用途, 枚举值 [0(数据输入),1(模型输入),2(模型输出),3(日志输出),4(训练代码),5(checkpoint)] |
表 env
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 变量名称 | ||
| value | 是 | String | 变量值 |
表 resource
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| roleName | 是 | String | 角色名称, 有效值 [Master,Worker] | ||
| replicas | 是 | Integer | 副本数,至少为1 | ||
| queueNodeDeviceID | 是 | String | 队列节点设备ID | 6e719d9e-b912-44b0-aae7-59207f342ee9 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(800)或者失败(900) | 800 | |
| errorCode | String | 错误代码 | Cwai.Api.xxxx | |
| message | String | 错误信息描述 | Invalid Request | |
| returnObj | Object | 业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskRecordID | String | 任务运行记录ID | task-py-5456850f-4033-4eae-9d9c-ae3687941f0c | |
| taskID | String | 任务ID | 7206ed7e-6e9b-4258-b665-ae192ddff65f |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/task-service/task/create
Content-Type:application/json
请求头header
workspaceID:1810e490-3c45-42a2-8428-08c50797e817
userAgent : "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/110.0"
请求体body
{
"name": "test7",
"regionID": "200000004062",
"remark": "test",
"trainFrame": "Pytorch",
"trainMode": "DDP",
"queueID": "fc5842e7-c396-4c3e-b59b-f40c0fb64d80",
"scope": 0,
"enableTensorboard": false,
"storages": [{
"type": "DataSource",
"subPath": "",
"podPath": "/data",
"storageID": "4702ac7f-4c5c-43f0-9923-d7ad5fc2ab31"
}
],
"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": [{
"replicas": 1,
"queueNodeDeviceID": "8bd12065-f643-4dbe-8685-3bf82dc5b521",
"roleName": "Worker"
}
]
}
响应示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"taskID": "7206ed7e-6e9b-4258-b665-ae192ddff65f",
"taskRecordID": "task-py-5456850f-4033-4eae-9d9c-ae3687941f0c"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
