多文档注入水印 - BatchCreateWatermarks
功能介绍
功能介绍:批量对多个文档注入水印,一次请求对一组文件执行水印嵌入,返回任务执行状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/watermark/batch-embed
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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,用于指定执行水印注入操作所属的项目,可通过调用IAM服务的查询项目列表接口获取。 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| task_name | 是 | String | 参数解释: 水印任务名称,用于标识和区分不同的水印注入任务。 约束限制: 必填 取值范围: 不涉及 默认取值: 不涉及 |
| task_id | 否 | String | 参数解释: 任务ID,水印注入任务的唯一标识,可通过查询水印任务列表接口获取。 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| file_url | 是 | String | 参数解释: 源文件URL,待注入水印的源文件URL地址。 约束限制: 必填 取值范围: 不涉及 默认取值: 不涉及 |
| dest_url | 是 | String | 参数解释: 目标文件URL,水印注入完成后的目标文件输出URL地址。 约束限制: 必填 取值范围: 不涉及 默认取值: 不涉及 |
| doc_type | 是 | String | 参数解释: 文档类型,用于指定水印注入的目标文档类型。 约束限制: 必填 取值范围: 支持的文档类型,如docx、pdf、xlsx等 默认取值: 不涉及 |
| visible_watermark | 否 | String | 参数解释: 可见水印,直接显示在文档上的水印内容,如文本内容或图片URL。 约束限制: 非必填,两者至少填写一种,否则参数校验失败 取值范围: 不涉及 默认取值: 不涉及 |
| blind_watermark | 否 | String | 参数解释: 盲水印,用于嵌入文档中的隐式水印信息,内容为编码后的字符串数据,肉眼无法直接识别。 约束限制: 非必填,两者至少填写一种,否则参数校验失败 取值范围: 不涉及 默认取值: 不涉及 |
| opacity | 否 | Float | 参数解释: 不透明度,表示水印显示的透明程度。取值范围为0.0~1.0,0.0表示完全透明,1.0表示完全不透明。 约束限制: 不涉及 取值范围: 0.0~1.0,0.0表示完全透明,1.0表示完全不透明 默认取值: 不涉及 |
| font_size | 否 | Integer | 参数解释: 字体大小,用于指定水印文字的显示字号(像素)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| rotation | 否 | Integer | 参数解释: 旋转角度,用于指定水印文字的旋转角度(°)。 约束限制: 不涉及 取值范围: 0~360 默认取值: 不涉及 |
| sparse_degree | 否 | Integer | 参数解释: 稀疏度,用于控制水印嵌入的密度,影响水印的隐蔽性和抗攻击能力。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| token | 否 | String | 参数解释: 令牌,用于身份校验的Token,可通过调用IAM服务查询用户Token接口获取。 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| type | 否 | String | 参数解释: 水印类型,用于指定水印的嵌入类型。 约束限制: 最大长度65535字符 取值范围: 支持的水印类型,如EMBED(嵌入水印)等 默认取值: 不涉及 |
| remark | 否 | String | 参数解释: 备注 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| state | 否 | Integer | 参数解释: 水印任务状态,表示是否启用水印注入任务。 约束限制: 不涉及 取值范围: 0表示关闭,1表示开启 默认取值: 不涉及 |
| doc_paths | 否 | Array of strings | 参数解释: 文件列表,数组中的每个元素为待注入水印的文件URL地址。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
多文档注入水印请求体
{
"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",
"doc_type" : "PDF",
"visible_watermark" : "internal-use-only",
"blind_watermark" : "asset-owner-001",
"opacity" : 0.8,
"font_size" : 24,
"rotation" : 45,
"sparse_degree" : 8,
"token" : "YzNhYjQ1ZmY4ZDlkNjIwYmE3YzQxNTJkZjY4YzA3MmY=",
"type" : "EMBED",
"remark" : "财务报告水印嵌入",
"state" : 1
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "多文档注入水印成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 多文档注入水印成功 |
错误码
请参见错误码。