DescribeLiveStreamWatermarks - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries watermark templates.

Operation description

This operation supports paging.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Domain	string	No	The main streaming domain.	live.yourdomain.com
KeyWord	string	No	The keyword for the search. You can specify a template ID or name. Fuzzy search is supported for names.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of templates to return on each page. The default value is 100.	100

Response elements

Element	Type	Description	Example
	object	The watermark template information.
Total	integer	The total number of matching entries.	100
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	The list of watermark templates.
	object	The list of watermark templates.
Type	integer	The watermark type. 0: Image.	0
XOffset	number	The X-axis offset of the watermark, in pixels. Note Relative to RefWidth. If OffsetCorner is TopLeft, XOffset is the horizontal distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive X points to the right.	50.0
RefWidth	integer	The reference width of the video background, in pixels.	1920
YOffset	number	The Y-axis offset of the watermark, in pixels. Note Relative to RefHeight. If OffsetCorner is TopLeft, YOffset is the vertical distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive Y points downward.	100.0
Height	integer	The height of the watermark image, in pixels. This value is relative to `RefHeight` and is scaled proportionally with the actual video resolution.	200
RefHeight	integer	The reference height of the video background, in pixels.	1080
PictureUrl	string	The URL of the watermark image.	http://example.com
Transparency	integer	The opacity of the watermark. Value range: `0` (fully transparent) to `255` (fully opaque).	255
Description	string	The custom description of the watermark.	my watermark
OffsetCorner	string	The anchor point for the watermark's position. Valid values: TopLeft TopRight BottomLeft BottomRight	TopRight
RuleCount	integer	The number of watermark rules configured for the domain.	12
Name	string	The name of the watermark.	livewatermark****
TemplateId	string	The ID of the watermark template.	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

Examples

Success response

JSON format

{
  "Total": 100,
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "WatermarkList": {
    "Watermark": [
      {
        "Type": 0,
        "XOffset": 50,
        "RefWidth": 1920,
        "YOffset": 100,
        "Height": 200,
        "RefHeight": 1080,
        "PictureUrl": "http://example.com",
        "Transparency": 255,
        "Description": "my watermark",
        "OffsetCorner": "TopRight",
        "RuleCount": 12,
        "Name": "livewatermark****",
        "TemplateId": "445409ec-7eaa-4 61d-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.