Querying Watermark Rules

Function

This API is used to query watermark rules that meet the specified criteria.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/watermark/rules

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
template_id	No	String	Definition Watermark template ID. Constraints The ID can only contain digits, letters, and hyphens (-). It is generated when the template is created. Range Length: 1 to 255 characters Default Value N/A
domain	No	String	Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A
app	No	String	Definition Application name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
channel_id	No	String	Definition OTT channel ID. Constraints N/A Range N/A Default Value N/A
stream	No	String	Definition It indicates a transcoding template ID for OTT, and a stream name for Cloud Live. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Offset where the query starts. Constraints N/A Value range: 0~4096 Default value: 0
limit	No	Integer	Definition Number of records on each page. Constraints N/A Value range: 1~100 Default value: 10

Request Parameters

**Table 3** 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 4** 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 5** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number of records. Range N/A
rules_infos	Array of WatermarkRule objects	Definition Watermark rule list.

**Table 6** WatermarkRule
Parameter	Type	Description
rule_name	String	Definition Watermark rule name. Constraints If this parameter is left blank, the default name is used. The default name is in the format of Domain name:Application name:Stream name, for example, example.com:live:stream. Range Length: 1 to 255 characters Default Value N/A
template_id	String	Definition Watermark template ID. Constraints The ID can only contain digits, letters, and hyphens (-). It is generated when the template is created. Range Length: 1 to 255 characters Default Value N/A
domain	String	Definition Domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A
app	String	Definition Application name. Constraints This parameter is optional for Cloud Live and mandatory for Media Live. Range Length: 1 to 128 characters Default Value N/A
stream	String	Definition Stream name. Constraints This parameter is optional in the OTT scenario. Range Length: 1 to 512 characters Default Value N/A
location	WatermarkLocation object	Definition Watermark position. Constraints N/A
channel_id	String	Definition Channel ID, which is used in the OTT scenario. Constraints N/A Range Length: 1 to 64 characters Default Value N/A
transcode_template_name	String	Definition Transcoding template name corresponding to the channel. This parameter is used in the OTT scenario. Constraints N/A Range Length: 1 to 255 characters Default Value N/A

**Table 7** 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 8** 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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://live.hwcloud.com/v1/{project_id}/watermark/rules

Example Responses

Status code: 200

Watermark rules queried.

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

Status code: 400

Invalid parameter.

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

Status Codes

Status Code	Description
200	Watermark rules queried.
400	Invalid parameter.

Error Codes

See Error Codes.

Parent Topic: Livestreaming Watermark Management

Previous topic: Creating a Watermark Rule

Next topic: Modifying 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.