查询图纸水印嵌入任务状态 - ShowEngineeringDrawingEmbedTaskStatus
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/watermark/embed/tasks/{task_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
| task_id | 是 | String | 参数解释: 任务ID 约束限制: 必填,长度64字符,前32位须等于项目ID 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
| status | Integer | 参数解释: 任务状态 取值范围: 0-任务进行中,1-任务成功,2-任务失败,3-任务超时 |
| total | Integer | 参数解释: 总任务数 取值范围: 0及以上 |
| completed | Integer | 参数解释: 已完成数 取值范围: 0及以上 |
| waited | Integer | 参数解释: 等待数 取值范围: 0及以上 |
| failed | Integer | 参数解释: 失败数 取值范围: 0及以上 |
| failed_embed_info | Array of EngineeringDrawingWmFailedEmbedInfo objects | 参数解释: 失败嵌入信息列表 取值范围: 不涉及 |
请求示例
查询批量嵌入工程图纸水印任务的状态。
/v1/{project_id}/watermark/embed/tasks/{task_id} 响应示例
状态码:200
{
"task_id" : "task-demo",
"status" : 0,
"total" : 10,
"completed" : 5,
"waited" : 5,
"failed" : 0
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。