接口功能介绍
运行任务
接口约束
华北2
URI
POST /v4/cwai/central/task-service/taskrecord/run
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
workspaceID | 是 | String | 工作空间ID | 1810e490-3c45-42a2-8428-08c50797e817 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 否 | String | 区域的唯一ID | 81f7728662dd11ec810800155d307d5b | |
taskID | 是 | String | 任务ID | task-py-5456850f-4033-4eae-9d9c-ae3687941f0c |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
errorCode | String | 错误代码 | Cwai.Api.xxxx | |
statusCode | Integer | 状态码 | 800 | |
message | String | 错误信息描述 | ||
returnObj | String | 返回值 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
taskRecordID | String | 任务记录ID, 立即运行时返回 | task-py-5456850f-4033-4eae-9d9c-ae3687941f0c |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/central/task-service/taskrecord/run
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
{
"taskID": "7206ed7e-6e9b-4258-b665-ae192ddff65f"
}
响应示例
{
"statusCode": 800,
"message": "成功",
"returnObj": {
"id": "task-py-d8435fab-cbcb-4d83-a6c1-1a7d90b0c123"
}
}
状态码
请参考 状态码
错误码
请参考 错误码