查询异步任务执行进度 - ShowTaskExecuteProgress
功能介绍
查询异步任务执行进度。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/jobs/{async_job_id}/progress
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| async_job_id | 是 | String | 参数解释: 异步任务的唯一标识符。调用导出创建模板接口后从响应中获取该ID,用于后续查询任务执行进度。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 否 | String | 参数解释: 查询异步任务类型 约束限制: 当前支持文件列表导出的进度查询 取值范围: file 默认取值: file |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 否 | String | 参数解释: 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 请根据语言环境,参考支持的范围指定请求语言类型。 取值范围:
默认取值: en-us |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 任务状态。 约束限制: 不涉及。 取值范围:
|
| progress | String | 参数解释: 任务执行进度。 约束限制: 不涉及。 取值范围: 不涉及 |
| error_code | String | 参数解释: 错误码,当任务报错时返回的错误代码。 约束限制:
取值范围: 格式为DRS.XXXXXX。 |
| error_message | String | 参数解释: 错误详细信息,当任务执行失败时返回的具体错误描述。 约束限制:
取值范围: 不涉及。 |
请求示例
查询异步任务执行进度。
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/62a055ae-ce03-4232-beb6-46c83b8ef2b2/progress 响应示例
状态码:200
OK
{
"status" : "pending"
} 错误码
请参见错误码。