創(chuàng)建數(shù)字水印嵌入任務(wù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| csas:CreateWmEmbedTask | create |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WmType | string | 是 | 水印類型。取值：
| PureDocument |
| Filename | string | 是 | 待嵌入文件的文件名，后端需要根據(jù)文件名的后綴判斷校驗(yàn)文件類型。 | abc****.pdf |
| FileUrl | string | 是 | 可用于下載待嵌入文件的 URL，需要可以公網(wǎng)訪問。 | https://example.com/abc****.pdf |
| WmInfoSize | long | 否 | 水印信息的容量位寬，默認(rèn)為 32。該參數(shù)嵌入和提取時(shí)需要保持一致。比如嵌入時(shí)使用的是 40 位的 SDK，那么提取時(shí)也需要將該值設(shè)為 40。 枚舉值：
| 32 |
| WmInfoUint | string | 否 | 10 進(jìn)制數(shù)字格式水印信息。若設(shè)置該值，則 WmInfoBytesB64 不能設(shè)置。 取值范圍取決于 WmInfoSize 參數(shù)：
| 123*** |
| WmInfoBytesB64 | string | 否 | Base64 編碼后的字符串格式水印信息 。若設(shè)置該值，則 WmInfoUint 不能設(shè)置。 | aGVsbG8gc2F***** |
| VideoIsLong | boolean | 否 | 視頻水印參數(shù)：是否使用長(zhǎng)視頻水印 SDK，默認(rèn)為 false。取值：
| false |
| VideoBitrate | string | 否 | 短視頻水印參數(shù)：含義為視頻的比特率，默認(rèn)會(huì)自動(dòng)獲取視頻的比特率，可以通過該參數(shù)強(qiáng)制指定提取時(shí)使用的比特率。通常無(wú)需設(shè)置該參數(shù)。 | 3000k |
| ImageEmbedLevel | long | 否 | 圖像水印參數(shù)：更大的值意味著更高的魯棒性，但是視覺質(zhì)量會(huì)下降。默認(rèn)值 2。取值：0~4。 | 2 |
| ImageEmbedJpegQuality | long | 否 | 圖像水印參數(shù)：期望的輸出圖像 jpeg 壓縮質(zhì)量因子，默認(rèn)值 95。取值：1~100。 | 95 |
| DocumentControl | object | 否 | 文檔水印控制參數(shù)。 | |
| InvisibleAntiTextCopy | boolean | 否 | 是否啟用零寬字符暗水印。零寬字符暗水印可以抵抗文檔增、刪、改、另存（格式不變）、部分文本復(fù)制粘貼、CopytoTxt 攻擊。不能抵抗格式轉(zhuǎn)換 toPDF 攻擊。取值：
| true |
| InvisibleAntiAllCopy | boolean | 否 | 是否啟用組件暗水印。組件暗水印可以抵抗文檔增、刪、改、另存（格式不變）、docx 全選復(fù)制拷貝到新 docx 文檔，不能抵抗格式轉(zhuǎn)換攻擊。取值：
| true |
| BackgroundControl | object | 否 | 背景水印控制參數(shù)。 | |
| BgAddVisible | boolean | 否 | 是否啟用背景明水印。取值：
| true |
| BgVisibleControl | object | 否 | 背景明水印控制參數(shù)。 | |
| VisibleText | string | 否 | 背景明水印文案。格式為 utf8 字符串。 | hello **** |
| Mode | string | 否 | 背景明水印模式。取值：
| pos |
| FontSize | long | 否 | 明水印文字字號(hào)。取值越大，字體越大。 | 30 |
| FontColor | string | 否 | 明水印文字顏色。格式為 0xFFFFFF RGB 顏色格式。如 0x000000 表示黑色。 | 0x000000 |
| Angle | long | 否 | 明水印文字逆時(shí)針旋轉(zhuǎn)角度。取值范圍 1~360。 | 30 |
| PosX | string | 否 | Mode 為 pos 時(shí)生效。控制明水印水平位置的參數(shù)，以左下角為原點(diǎn)。數(shù)值在 0～1 之間時(shí)，為比例控制。數(shù)值大于 1 時(shí)，為精確的像素位置控制。 | 0.5 |
| PosY | string | 否 | Mode 為 pos 時(shí)生效。控制明水印垂直位置的參數(shù)，以左下角為原點(diǎn)。數(shù)值在 0～1 之間時(shí)，為比例控制，數(shù)值大于 1 時(shí)，為精確的像素位置控制。 | 0.5 |
| HorizontalNumber | long | 否 | Mode 為 repeat 時(shí)生效。表示明水印在水平方向上重復(fù)出現(xiàn)的次數(shù)。 | 3 |
| VerticalNumber | long | 否 | Mode 為 repeat 時(shí)生效。表示明水印在垂直方向上重復(fù)出現(xiàn)的次數(shù)。 | 3 |
| Opacity | long | 否 | 明水印透明度參數(shù)。取值范圍 1~255。取值越大，越不透明。 | 100 |
| BgAddInvisible | boolean | 否 | 是否添加背景暗水印。取值：
| true |
| BgInvisibleControl | object | 否 | 背景暗水印控制參數(shù)。 | |
| Opacity | long | 否 | 背景暗水印透明度參數(shù)。取值范圍 1~13。取值越大，越不透明。 | 10 |
| CsvControl | object | 否 | CSV 水印控制參數(shù)。 | |
| Method | string | 否 | CSV 水印嵌入方法。取值：
| lossless_row_shift_embed |
| EmbedColumn | long | 否 | 有損嵌入控制參數(shù)：指定修改列，CSV 文件中該列必須為 float 數(shù)據(jù)，計(jì)數(shù)從 1 開始。 | 1 |
| EmbedPrecision | long | 否 | 有損嵌入控制參數(shù)：指定修改精度，表示修改的幅度，為 10 的 n 次方，比如 0 表示修改精度為 10^0，即個(gè)位部分，-1 表示小數(shù)點(diǎn)后一位，1 表示十位部分，若 float 數(shù)據(jù)無(wú)此精度的部分，則不修改。 | 0 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "BE4FB974-11BC-5453-9BE1-1606A73EACA6",
"Data": {
"TaskId": "job:5GfrJYsoaffmCE7Z5bZtjUefzxfd****"
}
}錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-10-29 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |