调用DescribeLiveStreamWatermarks查询水印模板列表。

使用说明

本接口支持指定分⻚参数查询水印模板列表信息，调用时请保证参数设置符合要求。

QPS限制

本接口的单用户QPS限制为60次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

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

系统规定参数，取值DescribeLiveStreamWatermarks。

PageNumber Integer 否 1

分页的页数。不传默认为1。
PageSize Integer 否 100

每⻚模板数值，不传默认为100。

返回数据

名称 类型 示例值 描述
RequestId String 5c6a2a0df228-4a64- af62-20e91b9676b3

请求ID。
WatermarkList Array of Watermark

水印模板列表。
Watermark
Description String my watermark

自定义水印描述信息。
Height Integer 200

水印图片高度，单位：px。
Name String livewatermark****

水印名称。
OffsetCorner String TopRight

水印位置。

  • TopLeft：左上。
  • TopRight：右上。
  • BottomLeft：左下。
  • BottomRight：右下。
PictureUrl String http://example.com

水印图片链接。
RefHeight Integer 1080

参考背景视频高，单位：px。
RefWidth Integer 1920

参考背景视频宽，单位：px。
TemplateId String 445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

水印模板ID。
Transparency Integer 255

水印透明度，数值越小越透明。取值：0~255。
Type Integer 0

水印类型。

  • 0：图片（目前只支持图片）。
  • 1：文字。
XOffset Float 50.0

⽔印X轴偏移，单位：px。

说明 相对于参考背景宽RefWidth， 如果选择的是TopLeft，那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向，即X轴的正⽅向是向右。
YOffset Float 100.0

⽔印Y轴偏移，单位：px。

说明 相对于参考背景⾼RefHeight，如果选择的是TopLeft，那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向，即Y轴的正⽅向是向下。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamWatermarks
&<公共请求参数>

正常返回示例

XML格式 

<DescribeLiveStreamWatermarkResponse>
  <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
  <WatermarkList>
        <Watermark>
              <RefHeight>1080</RefHeight>
              <Transparency>255</Transparency>
              <Type>0</Type>
              <Description>my watermark</Description>
              <PictureUrl>http://example.com</PictureUrl>
              <OffsetCorner>TopRight</OffsetCorner>
              <Height>200</Height>
              <YOffset></YOffset>
              <XOffset></XOffset>
              <RefWidth>1920</RefWidth>
              <TemplateId>445409ec-7eaa-4 61d-8f29-4bec2eb9 ****</TemplateId>
              <Name>livewatermark****</Name>
        </Watermark>
  </WatermarkList>
</DescribeLiveStreamWatermarkResponse>

JSON格式 

{
    "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
    "WatermarkList": {
        "Watermark": [
            {
                "RefHeight": "1080",
                "Transparency": "255",
                "Type": "0",
                "Description": "my watermark",
                "PictureUrl": "http://example.com",
                "OffsetCorner": "TopRight",
                "Height": "200",
                "YOffset": "",
                "XOffset": "",
                "RefWidth": "1920",
                "TemplateId": "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****",
                "Name": "livewatermark****"
            }
        ]
    }
}

错误码

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