创建数字水印嵌入任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
csas:CreateWmEmbedTask | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
WmType | string | 是 | 水印类型。取值:
| PureDocument |
Filename | string | 是 | 待嵌入文件的文件名,后端需要根据文件名的后缀判断校验文件类型。 | abc****.pdf |
FileUrl | string | 是 | 可用于下载待嵌入文件的 URL,需要可以公网访问。 | https://example.com/abc****.pdf |
WmInfoSize | long | 否 | 水印信息的容量位宽,默认为 32。该参数嵌入和提取时需要保持一致。比如嵌入时使用的是 40 位的 SDK,那么提取时也需要将该值设为 40。 枚举值:
| 32 |
WmInfoUint | string | 否 | 10 进制数字格式水印信息。若设置该值,则 WmInfoBytesB64 不能设置。 取值范围取决于 WmInfoSize 参数:
| 123*** |
WmInfoBytesB64 | string | 否 | Base64 编码后的字符串格式水印信息 。若设置该值,则 WmInfoUint 不能设置。 | aGVsbG8gc2F***** |
VideoIsLong | boolean | 否 | 视频水印参数:是否使用长视频水印 SDK,默认为 false。取值:
| false |
VideoBitrate | string | 否 | 短视频水印参数:含义为视频的比特率,默认会自动获取视频的比特率,可以通过该参数强制指定提取时使用的比特率。通常无需设置该参数。 | 3000k |
ImageEmbedLevel | long | 否 | 图像水印参数:更大的值意味着更高的鲁棒性,但是视觉质量会下降。默认值 2。取值:0~4。 | 2 |
ImageEmbedJpegQuality | long | 否 | 图像水印参数:期望的输出图像 jpeg 压缩质量因子,默认值 95。取值:1~100。 | 95 |
DocumentControl | object | 否 | 文档水印控制参数。 | |
InvisibleAntiTextCopy | boolean | 否 | 是否启用零宽字符暗水印。零宽字符暗水印可以抵抗文档增、删、改、另存(格式不变)、部分文本复制粘贴、CopytoTxt 攻击。不能抵抗格式转换 toPDF 攻击。取值:
| true |
InvisibleAntiAllCopy | boolean | 否 | 是否启用组件暗水印。组件暗水印可以抵抗文档增、删、改、另存(格式不变)、docx 全选复制拷贝到新 docx 文档,不能抵抗格式转换攻击。取值:
| true |
BackgroundControl | object | 否 | 背景水印控制参数。 | |
BgAddVisible | boolean | 否 | 是否启用背景明水印。取值:
| true |
BgVisibleControl | object | 否 | 背景明水印控制参数。 | |
VisibleText | string | 否 | 背景明水印文案。格式为 utf8 字符串。 | hello **** |
Mode | string | 否 | 背景明水印模式。取值:
| pos |
FontSize | long | 否 | 明水印文字字号。取值越大,字体越大。 | 30 |
FontColor | string | 否 | 明水印文字颜色。格式为 0xFFFFFF RGB 颜色格式。如 0x000000 表示黑色。 | 0x000000 |
Angle | long | 否 | 明水印文字逆时针旋转角度。取值范围 1~360。 | 30 |
PosX | string | 否 | Mode 为 pos 时生效。控制明水印水平位置的参数,以左下角为原点。数值在 0~1 之间时,为比例控制。数值大于 1 时,为精确的像素位置控制。 | 0.5 |
PosY | string | 否 | Mode 为 pos 时生效。控制明水印垂直位置的参数,以左下角为原点。数值在 0~1 之间时,为比例控制,数值大于 1 时,为精确的像素位置控制。 | 0.5 |
HorizontalNumber | long | 否 | Mode 为 repeat 时生效。表示明水印在水平方向上重复出现的次数。 | 3 |
VerticalNumber | long | 否 | Mode 为 repeat 时生效。表示明水印在垂直方向上重复出现的次数。 | 3 |
Opacity | long | 否 | 明水印透明度参数。取值范围 1~255。取值越大,越不透明。 | 100 |
BgAddInvisible | boolean | 否 | 是否添加背景暗水印。取值:
| true |
BgInvisibleControl | object | 否 | 背景暗水印控制参数。 | |
Opacity | long | 否 | 背景暗水印透明度参数。取值范围 1~13。取值越大,越不透明。 | 10 |
CsvControl | object | 否 | CSV 水印控制参数。 | |
Method | string | 否 | CSV 水印嵌入方法。取值:
| lossless_row_shift_embed |
EmbedColumn | long | 否 | 有损嵌入控制参数:指定修改列,CSV 文件中该列必须为 float 数据,计数从 1 开始。 | 1 |
EmbedPrecision | long | 否 | 有损嵌入控制参数:指定修改精度,表示修改的幅度,为 10 的 n 次方,比如 0 表示修改精度为 10^0,即个位部分,-1 表示小数点后一位,1 表示十位部分,若 float 数据无此精度的部分,则不修改。 | 0 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "BE4FB974-11BC-5453-9BE1-1606A73EACA6",
"Data": {
"TaskId": "job:5GfrJYsoaffmCE7Z5bZtjUefzxfd****"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-29 | OpenAPI 入参发生变更 | 查看变更详情 |