文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据水印/ 嵌入文档水印 - CreateWatermark
更新时间:2026-10-09 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-32,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

file

否

File

参数解释:

上传的文档文件

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

doc_type

是

String

参数解释:

文档类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

doc_path

否

String

参数解释:

文档OBS路径

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

file_password

否

String

参数解释:

文档密码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

visible_watermark

否

String

参数解释:

显式水印内容

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

blind_watermark

否

String

参数解释:

暗水印内容

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

font_size

否

Integer

参数解释:

水印字体大小

约束限制:

不涉及

取值范围:

不涉及

默认取值:

50

rotation

否

Integer

参数解释:

水印旋转角度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

45

opacity

否

Float

参数解释:

水印透明度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0.3

sparse_degree

否

Integer

参数解释:

水印稀疏度

约束限制:

不涉及

取值范围:

不涉及

默认取值:

1

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求状态,success为成功。

取值范围:

不涉及

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

资源ID

取值范围:

不涉及

请求示例

{ }

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "嵌入文档水印成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

嵌入文档水印成功

错误码

请参见错误码。

相关文档