功能描述
查询异步任务状态。
接口说明
任务的具体返回请参阅会产生异步任务的接口说明,部分接口会根据任务耗时情况返回同步或异步结果,此时异步结果通常与同步结果的格式保持一致。
请求
请求示例
GET /user/v1/task/
{OrganizationId}
/{TaskIdList}
?user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
TaskIdList:任务 ID 列表,用逗号分隔,例如
10
或 10,12,13
,必选参数。UserToken:访问令牌,必选参数。
请求体
该请求无请求体。
响应
响应码
查询成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
[{"taskId": 10,"status": 200,"result": { "path": [ "foo", "bar (1)" ] }},{"taskId": 12,"status": 202,"total": 20,"remaining": 10},{"taskId": 13,"status": 204},{"taskId": 14,"status": 207,"result": [{"code": "DuplicateRecord","status": 409,"message": "Duplicate Record for allowlist or user"}]},{"taskId": 15,"status": 499,"result": [...]}]
响应体字段说明:
taskId:整数,任务 ID。
status:整数,任务状态码,202:任务进行中,200:任务成功完成且有返回结果,返回结果在 result 字段中,204:任务成功完成且无返回结果,500:任务执行失败;499:用户取消; 207: 多状态。
result:对象数组,任务成功完成后的返回结果,具体格式由具体的异步任务确定。
total:整数,总的任务数量(如果该任务支持返回 total)。
remaining:整数,剩余任务数量(如果该任务支持返回 remaining)。