GetWmEmbedTask - 查询水印嵌入任务详情

使用创建水印嵌入任务得到的任务ID,查询嵌入任务结果。

调试

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

授权信息

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

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

请求参数

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

创建嵌入任务时得到的任务 ID。取值来源:

job:5GfrJYsoaffmCE7Z5bZtjU********

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次请求的 ID。

D6707286-A50E-57B1-B2CF-EFAC59E850D8
Dataobject

水印嵌入任务结果。

TaskIdstring

任务 ID。

job:5GfrJYsoaffmCE7Z5bZtjUxxxxxxxxxx
TaskStatusstring

任务状态。取值:

  • Running:运行中。
  • Success:成功。
  • Failed:失败。
Success
FileUrlstring

嵌入水印信息得到的文件的临时 URL。

https://example.com/embed-****.pdf
FileUrlExpstring

FileUrl 的过期时间,格式为 Unix 时间戳,精度为秒。

171859****
Filenamestring

嵌入水印信息得到的文件的文件名。

embed-****.pdf
OutFileHashMd5string

嵌入水印信息得到的文件的 md5 哈希,用于排查问题。

d41d8cd98f00b204e9800998ecf8****
OutFileSizelong

嵌入水印信息得到的文件的大小,单位为字节。用于排查问题。

123**

示例

正常返回示例

JSON格式

{
  "RequestId": "D6707286-A50E-57B1-B2CF-EFAC59E850D8",
  "Data": {
    "TaskId": "job:5GfrJYsoaffmCE7Z5bZtjUxxxxxxxxxx",
    "TaskStatus": "Success",
    "FileUrl": "https://example.com/embed-****.pdf",
    "FileUrlExp": "171859****",
    "Filename": "embed-****.pdf\n",
    "OutFileHashMd5": "d41d8cd98f00b204e9800998ecf8****",
    "OutFileSize": 0
  }
}

错误码

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