调用DescribeLiveStreamWatermarks查询水印模板列表-视频直播-阿里云

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

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamWatermarks

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
Domain	string	否	主播流域名。	live.yourdomain.com
KeyWord	string	否	搜索关键词。模板 ID 或名称，名称支持模糊搜索。	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	否	分页的页数。不传默认为 1。	1
PageSize	integer	否	每⻚模板数值，不传默认为 100。	100

返回参数

名称	类型	描述	示例值
	object	水印模板信息。
Total	integer	符合条件的总个数。	100
RequestId	string	请求 ID。	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	水印模板列表。
	object	水印模板列表。
Type	integer	水印类型。 0：图片（目前只支持图片）。 1：文字。	0
XOffset	number	⽔印 X 轴偏移，单位：px。说明相对于参考背景宽 RefWidth，如果选择的是 TopLeft，那么 XOffset 是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置 X。其中坐标指向背景视频中⼼的⽅向为正⽅向，即 X 轴的正⽅向是向右。	50.0
RefWidth	integer	参考背景视频宽，单位：px。	1920
YOffset	number	⽔印 Y 轴偏移，单位：px。说明相对于参考背景⾼RefHeight，如果选择的是 TopLeft，那么 YOffset 是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置 Y。其中坐标指向背景视频中⼼的⽅向为正⽅向，即 Y 轴的正⽅向是向下。	100.0
Height	integer	水印图片高度，单位：px。	200
RefHeight	integer	参考背景视频高，单位：px。	1080
PictureUrl	string	水印图片链接。	http://example.com
Transparency	integer	水印透明度，数值越小越透明。取值：0~255。	255
Description	string	自定义水印描述信息。	my watermark
OffsetCorner	string	水印位置。 TopLeft：左上。 TopRight：右上。 BottomLeft：左下。 BottomRight：右下。	TopRight
RuleCount	integer	Domain 下配置的水印规则数量	12
Name	string	水印名称。	livewatermark****
TemplateId	string	水印模板 ID。	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameters	%s

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

变更历史

更多信息，参考变更详情。