文档

GetDigitalWatermarkExtractResult - 查询数字水印提取作业

更新时间:

调用GetDigitalWatermarkExtractResult查询数字水印(版权水印或溯源水印)的提取作业结果,包括数字水印提取作业的状态、成功提取出的水印文字等信息。

接口说明

  • 目前本接口服务地址仅支持:华东 2(上海)、华北 2(北京)。
  • 调用 SubmitDigitalWatermarkExtractJob 接口提取视频的版权水印或溯源水印后,调用本接口查询提取出来的水印文字信息。
  • 目前仅支持查询最近 2 年内的水印提取作业。

调试

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

授权信息

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

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

请求参数

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

待查询的视频 ID,仅支持传入单个视频 ID。可通过以下方式获取:

93ab850b4f6f54b6e91d24d81d4****
ExtractTypestring

水印提取类型。取值:

  • TraceMark:溯源水印
  • CopyrightMark:版权水印
TraceMark
JobIdstring

水印提取作业 ID。

  • 调用 SubmitDigitalWatermarkExtractJob 接口后会返回。
  • 传入该参数,则可查询指定水印提取作业 ID 的结果;不传,则默认返回该视频下所有历史水印提取作业的结果。
2bf4390af9e5491c09cc720ad****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

42E0554B-80F4-4921-****-ACFB22CAAAD0
AiExtractResultListobject []

水印提取作业详情。

JobIdstring

水印提取作业 ID。

3af004763bcf459698860f4ede20****
CreateTimestring

水印提取作业的创建时间。

2023-09-16T02:49:04Z
ModifyTimestring

水印提取作业的最后更新时间。

2023-09-17T06:20:45Z
Statusstring

水印提取作业的状态。取值:

  • Success:成功
  • Failed:失败
  • Processing:处理中
Failed
ErrorMessagestring

报错提示信息。当水印提取作业处理失败(即StatusFailed)时,才会返回本参数。

query copyright info err
WaterMarkTextstring

提取出的水印文字。

test mark

示例

正常返回示例

JSON格式

{
  "RequestId": "42E0554B-80F4-4921-****-ACFB22CAAAD0",
  "AiExtractResultList": [
    {
      "JobId": "3af004763bcf459698860f4ede20****",
      "CreateTime": "2023-09-16T02:49:04Z",
      "ModifyTime": "2023-09-17T06:20:45Z",
      "Status": "Failed",
      "ErrorMessage": "query copyright info err",
      "WaterMarkText": "test mark"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)