调用QueryWaterMarkTemplateList通过水印模板ID查询水印模板详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 否 QueryWaterMarkTemplateList

操作接口名，系统规定参数，取值： QueryWaterMarkTemplateList。

WaterMarkTemplateIds String 是 88c6ca184c0e47*****b665e2a126797

水印模板ID列表。最多一次查10个，英文逗号（,）分隔。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。
NonExistWids Array of String 无

不存在的水印模板列表，无数据时该结构不返回。
WaterMarkTemplateList Array of WaterMarkTemplate

水印模板列表。
WaterMarkTemplate
Type String Image

水印类型。取值：Image、Text。

说明 目前仅支持Image。
RatioRefer Object

百分比参考。当Height， Width,，Dx， Dy是 （0,1）时，参考下列取值百分比。

取值：

  • Width：宽
  • Height：高
  • Long：长边
  • Short：短边
Dx String Width

水印图片相对输出视频的水平偏移量。

默认值：0。

值有两种形式：

  • 整数型代表偏移像素，范围：8，4096，单位：px。
  • 小数型代表水平偏移量与输出分辨率宽的比率，范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。
Width String 20

输出视频上水印图片宽。

值有两种形式：

  • 整数型代水印图片宽的像素值，范围：8,4096，单位：px。
  • 小数型代表相对输出视频分辨率宽的比率，范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。
Height String 20

输出视频上水印图片高。

值有两种形式：

  • 整数型代水印图片高的像素值，范围：8,4096，单位：px。
  • 小数型代表相对输出视频分辨率高的比率，范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。
Dy String Height

水印图片相对输出视频的垂直偏移量。

默认值：0。

值有两种形式：

  • 整数型代表偏移像素，范围8，4096，单位：px。
  • 小数型代表垂直偏移量与输出分辨率高的比率，范围：(0，1)，支持4位小数，如0.9999，超出部分系统自动丢弃。
ReferPos String TopRight

水印的位置。

  • TopRight、TopLeft、BottomRight、BottomLeft
State String Normal

水印模板的状态。取值：Normal、Deleted。
Dx String 100

水平偏移量。

  • 取值范围：[-4096，4096]
  • 单位：px
Width String 8

宽。

  • 取值范围：[8，4096]
  • 单位：px
Height String 8

高。

  • 取值范围：[8，4096]
  • 单位：px
Timeline Object

动态水印。
Start String 0

水印开始出现时间。

  • 单位：秒
  • 取值范围：数字
  • 默认值：0
Duration String 10

水印持续时间。

  • 取值范围：[数字，ToEND]
  • 默认值：ToEND
Name String example-watermark

水印模板名称。
Dy String 100

垂直偏移量。

  • 取值范围：[-4096，4096]
  • 单位：px
Id String 88c6ca184c0e47*****b665e2a126797

水印模板ID。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryWaterMarkTemplateList
&WaterMarkTemplateIds=88c6ca184c0e47*****b665e2a126797
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryWaterMarkTemplateListResponse>
    <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
    <NonExistWids>无</NonExistWids>
    <WaterMarkTemplateList>
        <Type>Image</Type>
        <RatioRefer>
            <Dx>Width</Dx>
            <Width>20</Width>
            <Height>20</Height>
            <Dy>Height</Dy>
        </RatioRefer>
        <ReferPos>TopRight</ReferPos>
        <State>Normal</State>
        <Dx>100</Dx>
        <Width>8</Width>
        <Height>8</Height>
        <Timeline>
            <Start>0</Start>
            <Duration>10</Duration>
        </Timeline>
        <Name>example-watermark</Name>
        <Dy>100</Dy>
        <Id>88c6ca184c0e47*****b665e2a126797</Id>
    </WaterMarkTemplateList>
</QueryWaterMarkTemplateListResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "25818875-5F78-4A*****F6-D7393642CA58",
  "NonExistWids" : "无",
  "WaterMarkTemplateList" : {
    "Type" : "Image",
    "RatioRefer" : {
      "Dx" : "Width",
      "Width" : 20,
      "Height" : 20,
      "Dy" : "Height"
    },
    "ReferPos" : "TopRight",
    "State" : "Normal",
    "Dx" : 100,
    "Width" : 8,
    "Height" : 8,
    "Timeline" : {
      "Start" : 0,
      "Duration" : 10
    },
    "Name" : "example-watermark",
    "Dy" : 100,
    "Id" : "88c6ca184c0e47*****b665e2a126797"
  }
}

错误码

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