DescribeLiveStreamWatermarkRules - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries watermark rules.

Operation description

When you call this operation, you can specify the PageNumber and PageSize parameters to view watermark rules on separate pages. Make sure that the parameter settings meet the requirements.

QPS limit

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveStreamWatermarkRules	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The main streaming domain.	live.yourdomain.com
PageNumber	integer	No	The page number. If you do not specify this parameter, the default value 1 is used.	1
PageSize	integer	No	The number of entries per page. If you do not specify this parameter, the default value 100 is used.	100

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The total number of entries that meet the specified conditions.	100
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b9676b3
RuleInfoList	array<object>	The watermark rules.
RuleInfo	object	The information about the watermark rule.
Domain	string	The streaming domain.	example.aliyundoc.com
Description	string	The description of the custom rule.	my rule
App	string	The name of the application to which the live stream belongs.	liveApp****
Stream	string	The name of the live stream. The following matching rules apply: A stream name can be exactly matched. Example: liveStreamA. Fuzzy match is also supported. The use of an asterisk (``) allows all approximate matches to be found. You can place the asterisk before or after an approximate string. Note* 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 name has the `t1` or `t2` suffix, and `(abc\|123)*` matches all streams whose name has the `abc` or `123` prefix.	liveStreamA
Name	string	The name of the custom rule.	WatermarkRule****
TemplateId	string	The ID of the watermark template. Note You can obtain the template ID by checking the value of the TemplateId parameter that is returned by the AddLiveStreamWatermark operation.	445409ec-7eaa-461d-8f29-4bec2eb9 ****
RuleId	string	The ID of the watermark rule. Note You can obtain the rule ID by checking the value of the RuleId parameter that is returned by the AddLiveStreamWatermarkRule operation.	445409ec-7eaa-461d -8f29-4bec2eb9****

Examples

Sample success responses

JSONformat

{
  "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****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameters	%s

For a list of error codes, visit the Service error codes.