多文档提取水印 - BatchListWatermarks
功能介绍
功能介绍:批量从多个文档提取水印,返回每个文档的水印提取结果。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/watermark/batch-extract
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 否 | String | 参数解释: 项目ID,用于标识该文档水印任务所属的项目,可通过调用查询项目列表接口获取 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| task_id | 否 | String | 参数解释: 提取水印任务ID,标识一次文档水印任务 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| task_name | 是 | String | 参数解释: 水印提取任务名称,标识一次文档水印提取任务的名称 约束限制: 满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*$" 取值范围: 不涉及 默认取值: 不涉及 |
| file_url | 是 | String | 参数解释: 水印文档文件URL,用于指定需要提取水印的文档文件所在位置 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| doc_type | 是 | String | 参数解释: 文档类型,用于指定待提取水印的文档文件的类型,如PDF、DOCX等 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| token | 否 | String | 参数解释: 访问令牌,用于鉴权访问目标存储服务(如OBS)中的文档文件,可通过调用获取临时访问令牌的接口获取 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| type | 否 | String | 参数解释: 水印类型,用于指定文档水印的处理方式,如嵌入水印或提取水印 约束限制: 最大长度65535字符 取值范围: EMBED-嵌入水印,EXTRACT-提取水印 默认取值: 不涉及 |
| doc_paths | 是 | Array of strings | 参数解释: 待提取水印的文档路径列表,数组元素为文档在 OBS 桶中的路径(如 obs://bucket/key/file.pdf)。 约束限制: 最多100个文件路径 取值范围: 不涉及 默认取值: 不涉及 |
| tasks | 否 | Array of strings | 参数解释: 任务ID列表,用于批量删除水印任务时指定待删除的任务ID集合。 约束限制: 最多100个任务ID 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
多文档提取水印请求体
{
"project_id" : "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
"task_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
"task_name" : "embed-task-01",
"file_url" : "obs://dsc-watermark-bucket/src/financial-report.pdf",
"doc_type" : "PDF",
"token" : "YzNhYjQ1ZmY4ZDlkNjIwYmE3YzQxNTJkZjY4YzA3MmY=",
"type" : "EMBED",
"doc_paths" : [ "obs://dsc-watermark-bucket/src/financial-report.pdf" ]
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "多文档提取水印成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 多文档提取水印成功 |
错误码
请参见错误码。