文档首页/ 数据安全中心 DSC/ API参考/ API/ 文档水印/ 嵌入文档水印 - CreateWatermark
更新时间:2026-11-13 GMT+08:00
分享

嵌入文档水印 - CreateWatermark

功能介绍

功能介绍:对单个文档嵌入水印,支持可见水印与盲水印,可配置字体、透明度、旋转角度等参数。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/sdg/watermark/embed

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

file

否

File

参数解释:

上传的文档文件,doc_type 为 LOCAL 时使用

约束限制:

doc_type 为 LOCAL 时必填

取值范围:

不涉及

默认取值:

不涉及

doc_type

是

String

参数解释:

文档来源类型

约束限制:

仅支持 OBS 或 LOCAL

取值范围:

  • OBS-从OBS读取文档

  • LOCAL-本地上传文档

默认取值:

不涉及

doc_path

否

String

参数解释:

文档OBS路径,格式为“桶名/对象路径”

约束限制:

doc_type 为 OBS 时必填;按第一个“/”切分为桶名和对象key

取值范围:

不涉及

默认取值:

不涉及

file_password

否

String

参数解释:

文档密码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

visible_watermark

否

String

参数解释:

显式水印内容

约束限制:

与 blind_watermark 至少传一个

取值范围:

不涉及

默认取值:

不涉及

blind_watermark

否

String

参数解释:

暗水印内容

约束限制:

与 visible_watermark 至少传一个

取值范围:

不涉及

默认取值:

不涉及

font_size

否

Integer

参数解释:

水印字体大小

约束限制:

不涉及

取值范围:

不涉及

默认取值:

50

rotation

否

Integer

参数解释:

水印旋转角度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

45

opacity

否

Float

参数解释:

水印透明度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0.3

sparse_degree

否

Integer

参数解释:

水印稀疏度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

1

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

Content-Disposition

String

嵌入水印后的文档文件名(如 attachment; filename="financial-report-watermarked.pdf")

Content-Length

Integer

响应文件流的字节数

表5 响应Body参数

参数

参数类型

描述

-

File

参数解释:

嵌入水印后的文档文件流

取值范围:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求处理状态,标识任务的执行结果

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

被删除的水印嵌入任务对应的资源ID

取值范围:

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求处理状态,标识任务的执行结果

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

被删除的水印嵌入任务对应的资源ID

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

无

状态码:400

{
  "status" : "fail",
  "msg" : "file url is null or empty",
  "id" : ""
}

状态码:500

{
  "status" : "fail",
  "msg" : "embed watermark exception",
  "id" : ""
}

状态码

状态码

描述

200

嵌入文档水印成功,返回嵌入水印后的文档文件流(application/octet-stream),通过Content-Disposition响应头携带文件名

400

请求参数错误,返回JSON格式错误信息

500

服务端异常,返回JSON格式错误信息

错误码

请参见错误码。

相关文档