功能描述
用于查询耗时任务执行情况。
接口说明
任务的具体返回请参阅会产生异步任务的接口说明,部分接口会根据任务耗时情况返回同步或异步结果,此时异步结果通常与同步结果的格式保持一致。
请求
请求示例
GET /api/v1/task/
{LibraryId}
/{SpaceId}
/{TaskIdList}
?access_token={AccessToken}
&user_id={UserId}
请求参数:
LibraryId:媒体库 ID,必选参数。
SpaceId:空间 ID,必须指定该参数,如果媒体库为单租户模式,则该参数固定为连字符(
-
)。TaskIdList:任务 ID 列表,用逗号分隔,例如
10
或 10,12,13
。AccessToken:访问令牌,必选参数。
UserId:用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅 生成访问令牌接口,可选参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
[{"taskId": 10,"status": 200,"result": { "path": [ "foo", "bar (1)" ] }},{"taskId": 12,"status": 202},{"taskId": 13,"status": 204}]
响应体字段说明:
taskId:任务 ID。
status:任务状态码。
202:任务进行中。
200:任务成功完成且有返回结果,返回结果在 result 字段中。
204:任务成功完成且无返回结果。
500:任务执行失败。
result:任务成功完成后的返回结果。