查询图纸水印提取任务结果 - ShowEngineeringDrawingExtractTaskResult
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/watermark/extract/tasks/{task_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 长度为32个字符 默认取值: 不涉及 |
| task_id | 是 | String | 参数解释: 任务ID,批量提取水印任务的唯一标识,可通过批量提取工程图纸水印任务接口获取 约束限制: 必填,长度64字符,前32位须等于项目ID 取值范围: 字符串类型,长度64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 批量提取水印任务的任务ID 取值范围: 字符串类型,长度1~64个字符 |
| status | Integer | 参数解释: 任务状态 取值范围: 0-任务进行中,1-任务成功,2-任务失败,3-任务超时 |
| total | Integer | 参数解释: 总任务数,即待提取水印的任务总数 取值范围: 0~100 |
| completed | Integer | 参数解释: 已完成数,即已完成提取水印的任务数量 取值范围: 0~100 |
| remark | Array of EngineeringDrawingWmExtractResult objects | 参数解释: 提取结果列表,每个元素为EngineeringDrawingWmExtractResult对象,包含图纸文件地址、水印内容、是否存在水印及状态等信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| file_address | String | 参数解释: 图纸文件地址,该图纸在OBS上的存储路径 取值范围: 格式为obs://bucket/file,字符串长度1~2048个字符 |
| watermark | String | 参数解释: 提取的水印内容 取值范围: 字符串类型,长度1~256个字符 |
| remark | String | 参数解释: 备注,附加的说明信息 取值范围: 字符串类型,长度1~1024个字符 |
| watermark_exist | Boolean | 参数解释: 是否存在水印,标识该图纸中是否检测到水印 取值范围: true:存在水印,false:不存在水印 |
| status | String | 参数解释: 任务状态,单个图纸的提取任务状态 取值范围: |
请求示例
查询批量提取工程图纸水印任务的结果。
/v1/{project_id}/watermark/extract/tasks/{task_id} 响应示例
状态码:200
{
"task_id" : "task-demo",
"status" : 1,
"total" : 10,
"completed" : 10,
"remark" : [ {
"file_address" : "obs://bucket/a.edif",
"watermark" : "blind-demo",
"watermark_exist" : true,
"status" : "success"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。