Queries watermark rules.

Usage notes

You can call this operation to query watermark rules. You can use the PageNumber parameter to view results on separate pages. Make sure that you configure parameters properly when you call this operation.

QPS limits

You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveStreamWatermarkRules

The operation that you want to perform. Set the value to DescribeLiveStreamWatermarkRules.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 100

The number of entries to return on each page. Default value: 100.

Response parameters

Parameter Type Example Description
RequestId String 5c6a2a0df228-4a64- af62-20e91b9676b3

The ID of the request.

RuleInfoList Array of RuleInfo

The watermark rules.

RuleInfo
Domain String example.aliyundoc.com

The streaming domain.

Description String my rule

The description of the custom rule.

App String liveApp****

The name of the application to which the live stream belongs.

Stream String liveStreamA

The name of the live stream. The following matching rules apply:

  • A stream name can be exactly matched, such as liveStreamA.
  • Fuzzy match is supported. You can use an asterisk (*) to allow all approximate matches to be found.
  • You can place the asterisk before or after an approximate string.
Important
  • Fuzzy match: Only one asterisk (*) before or after an approximate string is allowed. The approximate string must be enclosed in (). Separate multiple strings with vertical bars (|).
  • For example, *(t1|t2) matches all streams whose names have the t1 or t2 suffix, and (abc|123)* matches all streams whose names have the abc or 123 prefix.
Name String WatermarkRule****

The name of the custom rule.

TemplateId String 445409ec-7eaa-461d-8f29-4bec2eb9 ****

The ID of the watermark template.

Note TemplateId is returned in the response to the AddLiveStreamWatermark operation.
RuleId String 445409ec-7eaa-461d -8f29-4bec2eb9****

The ID of the watermark rule.

Note RuleId is returned in the response to the AddLiveStreamWatermarkRule operation.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamWatermarkRules
&<Common request parameters>

Sample success responses

XML format 

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 format 

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"
}

Error codes

For a list of error codes, visit the API Error Center.