水印提取任务日志列表 - ListWatermarkExtractLog
功能介绍
功能介绍:水印提取任务日志列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/watermark/extract-logs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询时每页返回的条目数量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页查询的偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 总记录数 取值范围: 不涉及 |
| water_mark_log | Array of WatermarkLogResponse objects | 参数解释: 水印日志列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 水印日志响应ID 取值范围: 不涉及 |
| task_name | String | 参数解释: 水印日志响应名称 取值范围: 不涉及 |
| task_id | String | 参数解释: 水印日志响应ID 取值范围: 不涉及 |
| file_url | String | 参数解释: 源文件URL地址 取值范围: 不涉及 |
| dest_url | String | 参数解释: 目标文件URL地址 取值范围: 不涉及 |
| visible_watermark | String | 参数解释: 可见水印内容 取值范围: 不涉及 |
| blind_watermark | String | 参数解释: 不可见暗水印内容 取值范围: 不涉及 |
| remark | String | 参数解释: 备注信息 取值范围: 不涉及 |
| state | Integer | 参数解释: 水印日志响应状态 取值范围: 最小值0,最大值2147483647 |
| total_file_num | Integer | 参数解释: 水印日志响应数量 取值范围: 最小值0,最大值2147483647 |
| finish_num | Integer | 参数解释: 已完成文件数 取值范围: 最小值0,最大值2147483647 |
| doc_path | String | 参数解释: 水印日志响应路径 取值范围: 不涉及 |
| file_exist | Boolean | 参数解释: 文件是否存在 取值范围: true-是,false-否 |
| download_url | String | 参数解释: 文件下载地址 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
{
"total" : 1,
"water_mark_log" : [ {
"project_id" : "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
"task_name" : "doc-watermark-embed-01",
"task_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
"file_url" : "obs://dsc-watermark-bucket/src/financial-report.pdf",
"dest_url" : "obs://dsc-watermark-bucket/dst/financial-report-watermarked.pdf",
"visible_watermark" : "internal-use-only",
"blind_watermark" : "asset-owner-001",
"remark" : "财务报告水印嵌入",
"state" : 1,
"total_file_num" : 10,
"finish_num" : 10,
"doc_path" : "obs://dsc-watermark-bucket/dst/",
"file_exist" : true,
"download_url" : "obs://dsc-watermark-bucket/dst/financial-report-watermarked.pdf"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。