Querying Watermark Templates

Function

This API is used to query watermark templates.

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

GET /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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	Array of strings	Watermark template IDs. A maximum of 10 IDs can be configured at a time.
page	No	Integer	Page number. The default value is 0. This parameter is invalid when id is specified.
size	No	Integer	Number of records on each page. The value defaults to 10 and ranges from 1 to 100. This parameter is invalid when id is specified.

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
templates	Array of WatermarkTemplate objects	Watermark template information.
total	Integer	Total number.

**Table 5** WatermarkTemplate
Parameter	Type	Description
name	String	Watermark template name.
id	String	Watermark template ID.
status	Long	Watermark template status. The options are: 0: disabled 1: Enabled
dx	String	Horizontal offset between the watermark and the output video The default value is 0.
dy	String	Vertical offset between the watermark and the output video The default value is 0.
position	String	Watermark position.
width	String	Watermark image width.
height	String	Watermark image height.
create_time	String	Creation time.
image_url	String	URL for downloading a watermark image.
type	String	Watermark image format. Only PNG, JPG, or JPEG images can be used as a watermark template. Only JPG, JPEG, and PNG strings are supported.
watermark_type	String	Watermark type. Currently, only IMAGE (image watermark) is supported.
image_process	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	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	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

Status code: 400

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

Example Requests

GET https://{endpoint}/v1.0/{project_id}/template/watermark?id={id}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "templates" : [ {
    "name" : "test",
    "id" : "2305739f855413a84af9e6ad6ebb21be",
    "status" : 0,
    "dx" : "0.05",
    "dy" : "0.05",
    "position" : "TOPRIGHT",
    "width" : "0.12",
    "height" : null,
    "create_time" : "20210204092325",
    "image_url" : "https://103-cn-north-4.cdn-vod.huaweicloud.com/05ab5cef408026f22f62c018de60cf2e/watermark/2305739f855413a84af9e6ad6ebb21be.png",
    "type" : "PNG",
    "watermark_type" : "IMAGE",
    "image_process" : "TRANSPARENT",
    "timeline_start" : null,
    "timeline_duration" : null
  } ],
  "total" : 1
}

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
200	Returned when the request succeeded.
400	Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Watermark Template Management

Previous topic: Modifying a Watermark Template

Next topic: Deleting a Watermark Template

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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot