Updated on 2026-08-19 GMT+08:00

Querying a Watermark Rule

Function

This API is used to query a watermark rule.

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	Definition Watermark rule ID. Constraints The ID can only contain digits, letters, and hyphens (-). It is generated when the template is created. 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
rule_name	String	Definition Watermark rule name. Range Length: 1 to 255 characters
template_id	String	Definition Watermark template ID. Range Length: 1 to 255 characters
domain	String	Definition Domain name. Range Length: 1 to 255 characters
app	String	Definition Application name. Range Length: 1 to 128 characters
stream	String	Definition Stream name. Range Length: 1 to 512 characters
location	WatermarkLocation object	Definition Watermark position.
channel_id	String	Definition Channel ID, which is used in the OTT scenario. Range Length: 1 to 64 characters
transcode_template_name	String	Definition Transcoding template name corresponding to the channel. This parameter is used in the OTT scenario. Range Length: 1 to 255 characters

**Table 5** WatermarkLocation
Parameter	Type	Description
location	String	Definition Watermark position. Range TOPLEFT: upper left TOPRIGHT: upper right BOTTOMLEFT: lower left BOTTOMRIGHT: lower right RANDOM: random If you select the random mode, the image watermark will appear randomly in the upper left, upper right, lower left, or lower right corner of the video stream. The specific position is further determined by the values of x_offset and y_offset. The watermark position changes every 5 to 30 minutes.
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) 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) Value range: 0~4096

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.

Parent Topic: Livestreaming Watermark Management