DescribeLiveStreamWatermarkRules - 查询水印规则列表 - 视频直播

调用DescribeLiveStreamWatermarkRules查询水印规则列表。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeLiveStreamWatermarkRules	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Domain	string	否	主播流域名。	live.yourdomain.com
PageNumber	integer	否	分⻚的⻚数，不传默认为 1。	1
PageSize	integer	否	分⻚每⻚个数，不传默认为 100。	100

返回参数

名称	类型	描述	示例值
	object
Total	integer	符合条件的总个数。	100
RequestId	string	请求 ID。	5c6a2a0df228-4a64- af62-20e91b9676b3
RuleInfoList	array<object>	⽔印规则列表。
RuleInfo	object	⽔印规则列表。
Domain	string	播流域名。	example.aliyundoc.com
Description	string	自定义规则描述信息。	my rule
App	string	播流所属应用名称。	liveApp****
Stream	string	流名称。规则如下：直接写流名称则仅匹配该流名称。示例：liveStreamA。可进行模糊匹配，``匹配所有流。可进行前匹配和后匹配。注意模糊匹配格式说明：模糊匹配下的``要求有且仅有一个，只能在最前或最后，且匹配项需要`()`包围，多个匹配项用竖线`\|`分隔。示例：`(t1\|t2)` 匹配所有后缀为`t1`或`t2`的流 `(abc\|123)`匹配所有前缀为`abc`或者`123`的流。	liveStreamA
Name	string	自定义规则名称。	WatermarkRule****
TemplateId	string	水印模板 ID。说明可查看 AddLiveStreamWatermark 接口返回参数值获取 TemplateId。	445409ec-7eaa-461d-8f29-4bec2eb9 ****
RuleId	string	水印规则 ID。说明可查看 AddLiveStreamWatermarkRule 接口返回参数值获取 RuleId。	445409ec-7eaa-461d -8f29-4bec2eb9****

示例

正常返回示例

JSON格式

{
  "Total": 100,
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "RuleInfoList": {
    "RuleInfo": [
      {
        "Domain": "example.aliyundoc.com",
        "Description": "my rule",
        "App": "liveApp****",
        "Stream": "liveStreamA",
        "Name": "WatermarkRule****",
        "TemplateId": "445409ec-7eaa-461d-8f29-4bec2eb9 ****",
        "RuleId": "445409ec-7eaa-461d -8f29-4bec2eb9****"
      }
    ]
  }
}

错误码

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

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