Help Center/ Live/ Cloud Live API Reference/ Livestreaming Watermark Management/ Querying Watermark Rule Configurations
Updated on 2025-08-13 GMT+08:00
View PDF

Querying Watermark Rule Configurations

Function

API for Querying Watermark Template Rules

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/watermark/rules/{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

Rule 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. 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

rule_name

String

Watermark rule name

template_id

String

Watermark template ID, which contains only digits, letters, and hyphens (-). The ID is generated when a template is created.

domain

String

Domain name

app

String

App name. Note: This parameter is optional for Clod Live and mandatory for Media Live.

stream

String

Stream name. This parameter is optional for OTT.

location

WatermarkLocation object

Watermark position

channel_id

String

This parameter is used for OTT. Set this parameter to the channel ID.

transcode_template_name

String

This parameter is used for OTT. Set this parameter to the name of the transcoding template corresponding to the channel.
Table 5 WatermarkLocation

Parameter

Type

Description

location

String

Watermark position. The options are TOPLEFT (upper left), TOPRIGHT (upper right), BOTTOMLEFT (lower left), BOTTOMRIGHT (lower right), and RANDOM (random). If RANDOM is used, the watermark will randomly appear on the upper left, upper right, lower left, or lower right of the video.

x_offset

Number

Horizontal offset between the watermark and the output video.

Options:

(1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels.

(2) A decimal indicates the ratio of the horizontal offset to the output video width. The value range is [0, 1).

The percentage can contain a maximum of four decimal places.

y_offset

Number

Vertical offset between the watermark and the output video.

Options:

(1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels.

(2) A decimal indicates the ratio of the vertical offset to the output video height. The value range is [0, 1).

The percentage can contain a maximum of four decimal places.

Status code: 400

Table 6 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 7 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/rules/e89b76xxxxxx3425ui80af501cdxxxxxx

Example Responses

Status code: 200

Watermark rules queried.

{
  "template_id" : "70b76xxxxxx34253880af501cdxxxxxx",
  "domain" : "push.example.com",
  "app" : "live",
  "stream" : "watermarkStream",
  "location" : {
    "location" : "TOPLEFT",
    "x_offset" : 20,
    "y_offset" : 10
  }
}

Status code: 400

Watermark rule query failed.

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

Status Codes

Status Code

Description

200

Watermark rules queried.

400

Watermark rule query failed.

Error Codes

See Error Codes.