DescribeLiveStreamWatermarks - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries watermark templates.

Operation description

You can call this operation to query watermark templates. 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 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:DescribeLiveStreamWatermarks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The name of the main streaming domain.	live.yourdomain.com
KeyWord	string	No	The keyword used in the query. You can specify the template ID or name. Fuzzy search is supported for the name.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of templates per page. Default value: 100.	100

Response parameters

Parameter	Type	Description	Example
	object	The information about the watermark template.
Total	integer	The total number of watermark templates that meet the specified conditions.	100
RequestId	string	The ID of the request.	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	array<object>	Details of the watermark templates.
Watermark	object
Type	integer	The watermark type. 0: image. Only image watermarks are supported. 1: text.	0
XOffset	float	The offset of the watermark along the x-axis. Unit: pixels. Note The value of the RefWidth parameter is used as the reference. If the OffsetCorner parameter is set to TopLeft, the value of the XOffset parameter indicates the x-axis offset of the upper-left corner of the watermark relative to that of the background video. The directions from the coordinate axes to the center of the background video are positive. In other words, the x-axis is positive toward the right.	50.0
RefWidth	integer	The width of the background video. Unit: pixels.	1920
YOffset	float	The offset of the watermark along the y-axis. Unit: pixels. Note The value of the RefHeight parameter is used as the reference. If the OffsetCorner parameter is set to TopLeft, the value of the YOffset parameter indicates the y-axis offset of the upper-left corner of the watermark relative to that of the background video. The directions from the coordinate axes to the center of the background video are positive. In other words, the y-axis is positive downward.	100.0
Height	integer	The height of the watermark. Unit: pixels.	200
RefHeight	integer	The height of the background video. Unit: pixels.	1080
PictureUrl	string	The URL of the watermark image.	http://example.com
Transparency	integer	The transparency of the watermark. A smaller value indicates a more transparent watermark. Valid values: 0 to 255.	255
Description	string	The description of the watermark.	my watermark
OffsetCorner	string	The position of the watermark. TopLeft: the upper-left corner. TopRight: the upper-right corner. BottomLeft: the lower-left corner. BottomRight: the lower-right corner.	TopRight
RuleCount	integer	The number of watermark rules configured for the domain name.	12
Name	string	The name of the watermark.	livewatermark****
TemplateId	string	The ID of the watermark template.	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

Examples

Sample success responses

JSONformat

{
  "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
400	InvalidParameters	%s

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