Help Center/ Video On Demand/ API Reference/ Watermark Template Management/ Modifying a Watermark Template
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Watermark Template

Function

This API is used modify a watermark template.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1.0/{project_id}/template/watermark

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Watermark template ID.

name

Yes

String

Watermark template name.

dx

No

String

Horizontal offset of the watermark image relative to the output video. The default value is 0.

The value can be an integer or in decimals. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

  • Integer: horizontal offset between the watermark start point and the output video vertex, in pixels. Value range: [0, 4096]

  • Decimal: horizontal offset ratio of the watermark start point to the video width. Value range: (0, 1). A maximum of four decimal places are supported, for example, 0.9999.

dy

No

String

Vertical offset of the watermark image relative to the output video. The default value is 0.

The value can be an integer or in decimals. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

  • Integer: vertical offset between the watermark start point and the video vertex, in pixels. Value range: [0, 4096]

  • Decimal: vertical offset ratio of the watermark start point to the video height. Value range: (0, 1). A maximum of four decimal places are supported, for example, 0.9999.

position

No

String

Watermark position. The default value is TOPRIGHT.

Possible options:

  • TOPRIGHT: upper right

  • TOPLEFT: upper left

  • BOTTOMRIGHT: lower right

  • BOTTOMLEFT: lower left

width

No

String

Watermark image width. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

Possible options:

  • Integer: width of a watermark image, in pixels. Value range: [8, 4096].

  • Decimal: ratio of the width to the width of the output video. The value range is (0, 1). Up to four decimal places are displayed, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

height

No

String

Watermark image height. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

Possible options:

  • Integer: height of a watermark image, in pixels. Value range: [8, 4096]

  • Decimal: ratio of the height to the height of the output video. The value range is (0, 1). Up to four decimal places are displayed, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

watermark_type

No

String

Watermark type. Currently, only IMAGE (image watermark) is supported.

image_process

No

String

This parameter is valid when watermark_type is set to IMAGE.

Possible options:

  • ORIGINAL: Only simple scaling is performed.

  • TRANSPARENT: The background color of the image is transparent.

  • GRAYED: The colored image turns gray.

timeline_start

No

String

Watermark start time, which is used together with timeline_duration

Value range: [0, END). END indicates the video end time.

Unit: second

timeline_duration

No

String

Watermark duration, which is used together with "timeline_start".

Value range: (0, END - start time]. END indicates the video end time.

Unit: second

Default value: END

Response Parameters

Status code: 204

Returned when the request succeeded.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example modifies a watermark template.

PUT https://{endpoint}/v1.0/{project_id}/template/watermark

Content-Type: application/json
{
  "id": "2305739f855413a84af9e6ad6ebb21be",
  "name": "test"
}

Example Responses

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

204

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.