获取异步任务信息
适用版本>=v7.0.2310a.20231019
接口说明:获取异步任务信息
请求说明
| 请求地址 | 配置域名+/graph+/v7/drive_tasks/{task_id}/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 更新文件(用户授权) kso.file.write查询文件(用户授权) kso.file.read 应用管理文件(应用授权) kso.appdrive.file.write 应用查询文件(应用授权) kso.appdrive.file.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id | string | 是 | 任务id,<= 1024 characters |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 获取异步任务信息信息返回 |
| ∟ done | int | 文件成功条数 |
| ∟ failed | int | 文件失败条数 |
| ∟ status | string | Enum: “success” “running” “failed”,任务状态 |
| ∟ total | int | 文件总条数 |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
{
"data": {
"done": 0,
"failed": 0,
"status": "success",
"total": 0
},
"code": 0,
"detail": "string",
"msg": "string"
}