任务
查看任务状态
接口描述
查看异步任务状态。
接口路径
GET /v1/tasks/:id
请求参数
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
id | /v1/tasks/1 | 查看id为1的任务 |
返回数据
名称 | 类型 | 描述 |
---|---|---|
code | int | 状态码(100001表示成功,其它表示异常) |
msg | string | 状态码描述信息 |
data | object | 响应数据,数据结构见示例 |
- id | int | 任务ID |
- created_at | time | 创建时间 |
- updated_at | time | 更新时间 |
- state | int | 任务状态,值含义如下:1:任务执行成功;2:任务正在执行;3:任务执行失败;4:任务执行超时 |
reason | string | 异常时的原因 |
返回数据示例:
{
"code": 100001,
"msg": "success",
"data": {
"id": 1, // 任务ID
"created_at": "2023-11-28T16:56:50.444+08:00", // 创建时间
"updated_at": "2023-11-28T16:56:53.449+08:00", // 更新时间
"state": 4 // 任务状态
}
}
任务状态码含义:
- 1:任务执行成功
- 2:任务执行中
- 3:任务执行失败
- 4:任务执行超时