All Products
Search

This Product

    ApsaraVideo Live:UpdateLiveStreamWatermark

    Document Center

    ApsaraVideo Live:UpdateLiveStreamWatermark

    Last Updated:Jul 11, 2025

    Updates a watermark template.

    Operation description

    This operation lets you update parameters of a watermark template with the specified TemplateId.

    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. We recommend that you consider this limit when calling this operation.

    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 support 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    TemplateId

    string

    Yes

    The ID of the watermark template.

    Note

    You can obtain the TemplateId from the response parameters 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 background video. Unit: pixels.

    1920
    RefHeight

    integer

    No

    The height of the background video. Unit: pixels.

    1080
    XOffset

    number

    No

    The X-axis offset of the watermark. Unit: pixels.

    Note

    This value is relative to the reference background width (RefWidth). If TopLeft is selected, XOffset refers to the relative position of the upper-left corner of the watermark image to the upper-left corner of the background video on the X-axis. The positive direction of coordinates points toward the center of the background video, which means the positive direction of the X-axis is to the right.

    50.0
    YOffset

    number

    No

    The Y-axis offset of the watermark. Unit: pixels.

    Note

    This value is relative to the reference background height (RefHeight). If TopLeft is selected, YOffset refers to the relative position of the upper-left corner of the watermark image to the upper-left corner of the background video on the Y-axis. The positive direction of coordinates points toward the center of the background video, which means the positive direction of the Y-axis is downward.

    100.0
    Height

    integer

    No

    The height of the watermark. Unit: pixels. The final size is determined by adaptive scaling based on the reference background height (RefHeight).

    200
    Transparency

    integer

    No

    The transparency of the watermark. A smaller value indicates a more transparent watermark. Valid values: 0 to 255.

    255
    OffsetCorner

    string

    No

    The position. 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 ID of the request.

    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.