UpdateLiveStreamWatermark - ApsaraVideo Live - Alibaba Cloud Documentation Center

Updates a watermark template.

Operation description

This operation updates the parameters of a specified watermark template.

QPS limits

The queries per second (QPS) limit for this operation is 60 per user. API calls that exceed this limit are throttled, which can affect your business. Plan your API calls to avoid exceeding this limit.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
TemplateId	string	Yes	The ID of the watermark template. Note You can get the template ID from the response of the AddLiveStreamWatermark operation.	445409ec-7eaa-461d-8f29-4bec2eb9****
Name	string	No	The name of the watermark.	livewatermark****
Description	string	No	The description of the watermark.	my watermark
RefWidth	integer	No	The width of the reference background video, in pixels.	1920
RefHeight	integer	No	The height of the reference background video, in pixels.	1080
XOffset	number	No	The offset of the watermark on the X-axis, in pixels. Note The offset is relative to the reference background width (RefWidth). If you set OffsetCorner to TopLeft, XOffset specifies the horizontal distance between the top-left corner of the watermark and the top-left corner of the background video. The positive direction points toward the center of the video. For the X-axis, the positive direction is to the right.	50.0
YOffset	number	No	The offset of the watermark on the Y-axis, in pixels. Note The offset is relative to the reference background height (RefHeight). If you set OffsetCorner to TopLeft, YOffset specifies the vertical distance between the top-left corner of the watermark and the top-left corner of the background video. The positive direction points toward the center of the video. For the Y-axis, the positive direction is downward.	100.0
Height	integer	No	The height of the watermark image, in pixels. The final height is adaptively scaled based on the value of RefHeight.	200
Transparency	integer	No	The transparency of the watermark. The smaller the value, the more transparent the watermark. Valid values: 0 to 255.	255
OffsetCorner	string	No	The position of the watermark. Valid values: TopLeft: The upper-left corner. TopRight: The upper-right corner. BottomLeft: The lower-left corner. BottomRight: The lower-right corner.	TopRight
PictureUrl	string	No	The URL of the watermark image.	http://example.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0df228-4a64-af62-20e91b9676b3

Examples

Success response

JSON format

{
  "RequestId": "5c6a2a0df228-4a64-af62-20e91b9676b3"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.