AddLiveStreamWatermarkRule - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds a watermark rule.

Operation description

After you add a watermark template by calling the AddLiveStreamWatermark operation, call this operation to create a rule that applies the template.

QPS limits

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:AddLiveStreamWatermarkRule

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Name	string	Yes	The name of the custom rule.	WatermarkRule****
Domain	string	Yes	The streaming domain.	example.aliyundoc.com
App	string	Yes	The AppName of the live stream.	liveApp****
Stream	string	Yes	The stream name. The following rules apply: To match a specific stream, enter the full stream name. For example, liveStreamA. You can use a wildcard match. The asterisk (``) matches all streams. You can perform prefix and suffix matching. Note* You can use only one asterisk (``). The asterisk must be at the beginning or end of the string. The matching items must be enclosed in parentheses (`()`) and separated by a vertical bar (`\|`). For example, `(t1\|t2)` matches all streams that end with `t1` or `t2`. `(abc\|123)*` matches all streams that start with `abc` or `123`.	liveStreamA
TemplateId	string	Yes	The ID of the watermark template. Note Get the template ID from the response of the AddLiveStreamWatermark operation.	445409ec-7eaa-461d-8f29-4bec2eb9****
Description	string	No	The description of the custom rule.	my rule

Response elements

Element	Type	Description	Example
	object
RuleId	string	The ID of the watermark rule.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0df228-4a64-af62-20e91b96****

Examples

Success response

JSON format

{
  "RuleId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0df228-4a64-af62-20e91b96****"
}

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.