DescribeLiveStreamWatermarkRules - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries a list of watermark rules.

Operation description

This operation supports pagination.

QPS limit

You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamWatermarkRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Domain	string	No	The streaming domain.	live.yourdomain.com
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 100.	100

Response elements

Element	Type	Description	Example
	object
Total	integer	The total number of matching entries.	100
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b9676b3
RuleInfoList	object
RuleInfo	array<object>	The list of watermark rules.
	object	The list of watermark rules.
Domain	string	The streaming domain.	example.aliyundoc.com
Description	string	The custom description of the rule.	my rule
App	string	The AppName of the live stream.	liveApp****
Stream	string	The stream name. The following matching methods are supported: Exact match: Enter the full stream name. Example: liveStreamA. Wildcard match: Use an asterisk (``) to match all streams. Fuzzy match: Use prefix or suffix matching. Important* Format for fuzzy matching: Use only one asterisk (``). The asterisk must be at the beginning or end of the string. Enclose the matching items in parentheses (`()`) and separate multiple items with vertical bars (`\|`). Examples: `(t1\|t2)` matches all streams that end with `t1` or `t2`. `(abc\|123)*` matches all streams that start with `abc` or `123`.	liveStreamA
Name	string	The custom name of the rule.	WatermarkRule****
TemplateId	string	The ID of the watermark template. Note To obtain the template ID, check the response of the AddLiveStreamWatermark operation.	445409ec-7eaa-461d-8f29-4bec2eb9 ****
RuleId	string	The ID of the watermark rule. Note To obtain the rule ID, check the response of the AddLiveStreamWatermarkRule operation.	445409ec-7eaa-461d -8f29-4bec2eb9****

Examples

Success response

JSON format

{
  "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	Description
400	InvalidParameters	%s Please check and try again later.	Exception parameter exists, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.