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

使用说明

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值：DescribeLiveStreamWatermarkRules。
Domain String 否 live.yourdomain.com

主播流域名。
PageNumber Integer 否 1

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

分⻚每⻚个数，不传默认为100。

返回数据

名称 类型 示例值 描述
Total Integer 100

符合条件的总个数。
RequestId String 5c6a2a0df228-4a64- af62-20e91b9676b3

请求ID。
RuleInfoList Array of RuleInfo

⽔印规则列表。
RuleInfo
Domain String example.aliyundoc.com

播流域名。
Description String my rule

自定义规则描述信息。
App String liveApp****

播流所属应用名称。
Stream String liveStreamA

流名称。规则如下：

  • 直接写流名称则仅匹配该流名称。示例：liveStreamA。
  • 可进行模糊匹配，*匹配所有流。
  • 可进行前匹配和后匹配。
重要
  • 模糊匹配格式说明：模糊匹配下的*要求有且仅有一个，只能在最前或最后，且匹配项需要()包围，多个匹配项用竖线|分隔。
  • 示例：*(t1|t2) 匹配所有后缀为t1或t2的流 (abc|123)*匹配所有前缀为abc或者123的流。
Name String WatermarkRule****

自定义规则名称。
TemplateId String 445409ec-7eaa-461d-8f29-4bec2eb9 ****

水印模板ID。

说明 可查看AddLiveStreamWatermark接口返回参数值获取TemplateId。
RuleId String 445409ec-7eaa-461d -8f29-4bec2eb9****

水印规则ID。

说明 可查看AddLiveStreamWatermarkRule接口返回参数值获取RuleId。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeLiveStreamWatermarkRulesResponse>
<RuleInfoList>
    <RuleInfo>
        <App>liveApp****</App>
        <Description>my rule</Description>
        <RuleId>445409ec-7eaa-461d -8f29-4bec2eb9****</RuleId>
        <Stream>liveStreamA</Stream>
        <Domain>example.aliyundoc.com</Domain>
        <TemplateId>445409ec-7eaa-461d-8f29-4bec2eb9 ****</TemplateId>
        <Name>WatermarkRule****</Name>
    </RuleInfo>
</RuleInfoList>
<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
</DescribeLiveStreamWatermarkRulesResponse>

JSON格式

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

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

错误码

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