Querying a Watermark Template

Function

This API is used to query the details of a watermark template.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/watermark/templates/{id}

**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.
id	Yes	String	Definition Template ID. Constraints The value is returned after the creation succeeds. Range Length: 1 to 128 characters Default Value N/A

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. The token 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 the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.)

**Table 4** Response body parameters
Parameter	Type	Description
name	String	Definition Watermark template name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A
type	Integer	Definition Watermark type. 0: image 1: text 2: image and text Constraints N/A Default Value N/A Value range: 0~2
description	String	Definition Template description. Constraints N/A Range Length: 0 to 512 characters Default Value N/A
picture_url	String	Definition Image download path. Constraints Verification rule: An image URL must contain 1 to 2,048 characters, must be in a valid format, and must use the HTTP or HTTPS protocol. (In the OTT scenario, only HTTPS is supported.) Image format: The file name extension must be .png, .jpg, .PNG, or .JPG. Range Length: 1 to 2,048 characters Default Value N/A
width	Number	Definition Integer: width of the watermark image, in pixels. The value can be 0 or an integer from 8 to 4,096. Decimal: ratio of the watermark width to the output video width. Value range: [0, 1) Constraints To avoid distortion, you are advised to specify only one dimension (width or height). The other will be scaled automatically. If both the width and height are set to 0, the original width and height of the watermark image are used. The ratio can contain a maximum of four decimal places. The width and height must both be in pixels or ratios. Default Value N/A Value range: 0~4096
height	Number	Definition Watermark image height. Options: Integer: height of the watermark image, in pixels. The value can be 0 or an integer from 8 to 4,096. Decimal: ratio of the watermark height to the output video width. Value range: [0, 1) Constraints To avoid distortion, you are advised to specify only one dimension (width or height). The other will be scaled automatically. If both the width and height are set to 0, the original width and height of the watermark image are used. The ratio can contain a maximum of four decimal places. The width and height must both be in pixels or ratios. Default Value N/A Value range: 0~4096
location	WatermarkLocation object	Definition Watermark position. Constraints N/A
text	WordWaterMarkInfo object	Definition Text watermark information. Constraints N/A
scene	String	Definition Service type. Constraints Modification is not supported. Range cloud_live: Cloud Live media_live: Media Live Default value: cloud_live

**Table 5** WordWaterMarkInfo
Parameter	Type	Description
format	String	Definition Text content. Constraints This parameter is mandatory when type is set to 1 or 2. This parameter is optional when type is set to 0. Range Length: 1 to 64 characters Default Value N/A
font_color	String	Definition Text color. Constraints N/A Range Parameter verification: The value must start with a #, followed by 6 or 8 characters. Only digits (0–9), uppercase letters (A–F), and lowercase letters (a–f) are allowed. [Verification is mandatory. If the input is invalid, the text will be displayed in white by default.] Default value: #000000
font_size	Integer	Definition Font size. Constraints N/A Value range: 4~72 Default value: 14
font	String	Definition Font. Constraints N/A Range harmonyRegular: HarmonyOS Sans Regular douyu2.0: DOUYU Font Length: 1 to 20 characters Default Value By default, the value is blank.
time_zone	String	Definition Time zone. Constraints N/A Range The value ranges from UTC-1200 to UTC+1200. The first three characters are UTC, the fourth character is + or -, the fifth and sixth characters indicate the hour, and the seventh and eighth characters are fixed at 00. Default value: UTC+0800
shadow_color	String	Definition Shadow color. Constraints N/A Range Parameter verification: The value must start with a #, followed by 6 or 8 characters. Only digits (0–9), uppercase letters (A–F), and lowercase letters (a–f) are allowed. [Verification is mandatory. If the input is invalid, the text will be displayed in black by default.] Default Value The default value is none.
location	WatermarkLocation object	Definition Location. Constraints It is mandatory.

**Table 6** WatermarkLocation
Parameter	Type	Description
location	String	Definition Watermark position. Constraints N/A Range TOPLEFT: upper left TOPRIGHT: upper right BOTTOMLEFT: lower left BOTTOMRIGHT: lower right Random: The image watermark may appear in any corner of the video stream (upper left, upper right, lower left, or lower right). Default Value N/A
x_offset	Number	Definition Horizontal offset between the watermark and the output video. Options: An integer indicates the offset in pixels. Value range: [1, 4096] A decimal indicates the ratio of the horizontal offset to the output video width. Value range: [0, 1) Constraints The offset ratio can have a maximum of four decimal places. Default Value N/A Value range: 0~4096
y_offset	Number	Definition Vertical offset between the watermark and the output video. Options: An integer indicates the offset in pixels. Value range: [1, 4096] A decimal indicates the ratio of the vertical offset to the output video height. Value range: [0, 1) Constraints The offset ratio can have a maximum of four decimal places. Default Value N/A Value range: 0~4096

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.)

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://{endpoint}/v1/{project_id}/watermark/templates/e89b76xxxxxx3425ui80af501cdxxxxxx

Example Responses

Status code: 200

Watermark templates queried.

{
  "name" : "MyWatermarkTemplate",
  "type" : 0,
  "description" : "my demo template",
  "picture_url" : "http://example.com/picture",
  "width" : 0.1,
  "height" : 0.1,
  "location" : {
    "location" : "TOPLEFT",
    "x_offset" : 20,
    "y_offset" : 10
  }
}

Status code: 400

Watermark template query failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code	Description
200	Watermark templates queried.
400	Watermark template query failed.

Error Codes

See Error Codes.

Parent Topic: Livestreaming Watermark Management

Previous topic: Deleting a Watermark Template

Next topic: Creating a Watermark Rule

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.