文档

CreateWmExtractTask - 创建水印提取任务

更新时间:

创建数字水印提取任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
csas:CreateWmExtractTask
  • 全部资源
    *

请求参数

名称类型必填描述示例值
WmTypestring

水印类型。取值:

  • PureWebappInvisible:网页水印。
  • PureAppInvisible:App 水印。
  • PureScreenInvisible:屏幕水印。
  • PureDocument:文档水印。
  • PureImage:图片水印。
  • PureAudio:音频水印。
  • PureVideo:视频水印。
  • AigcWebappInvisible:AIGC 网页水印。
  • AigcAppInvisible:AIGC App 水印。
  • AigcScreenInvisible:AIGC 屏幕水印。
  • AigcDocument:AIGC 文档水印。
  • AigcImage:AIGC 图片水印。
  • AigcAudio:AIGC 音频水印。
  • AigcVideo:AIGC 视频水印。
PureDocument
FileUrlstring

用于下载待提取文件的 URL,需要可以公网访问。

https://example.com/test-****.pdf
Filenamestring

待提取文件的文件名,后端需要根据文件名的后缀判断校验文件类型。

test-****.pdf
WmInfoSizelong

水印信息的容量位宽,默认为 32。该参数嵌入和提取时需要保持一致。比如嵌入式使用的是 40 位的 SDK,那么提取时也需要将该值设为 40。

32
VideoSpeedstring

长视频水印参数:含义为视频倍速,浮点数字符串。默认 1,代表添加水印时的采用倍速,或者添加水印之后,视频时间轴拉伸的倍速。

1
VideoIsLongboolean

视频水印参数:是否使用长视频水印 SDK,默认为 false。取值:

  • true:是
  • false:否
false
DocumentIsCaptureboolean

文档水印参数:指定待提取文件是否为添加了背景水文档的截图。服务会根据待提取文件是否为图像文件来判断是否走文档背景水印提取逻辑,因此默认无需设置该参数 。取值:

  • true:是
  • false:否
false

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

D6707286-A50E-57B1-B2CF-EFAC59E850D8
Dataobject

水印提取任务信息。

TaskIdstring

任务 ID,用于查询任务结果。

wmt-9648c22d2eb2cb57bb855dcae7898464********

示例

正常返回示例

JSON格式

{
  "RequestId": "D6707286-A50E-57B1-B2CF-EFAC59E850D8",
  "Data": {
    "TaskId": "wmt-9648c22d2eb2cb57bb855dcae7898464********"
  }
}

错误码

访问错误中心查看更多错误码。