SearchWaterMarkTemplate - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Searches for watermark templates.

Operation description

The total number of returned entries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mts:SearchWaterMarkTemplate	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	long	No	The number of entries per page. A maximum of 100 entries can be returned on each page. Default value: 10.	10
PageNumber	long	No	The page number. Default value: 1.	1
State	string	No	The state of the watermark templates that you want to query. Valid values: All (default) Normal Deleted	Normal

Response parameters

Parameter	Type	Description	Example
	object	The details of the watermark templates.
TotalCount	long	The type of the watermark. Valid values: Image: an image watermark. Text: a text watermark. Note Only watermarks of the Image types are supported.	1
PageSize	long	The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence: Width: the width edge. Height: the height edge. Long: the long edge. Short: the short edge.	10
RequestId	string	The ID of the request.	FC029D04-8F47-57FF-A759-23383C15617D
PageNumber	long	The width of the watermark image in the output video. The value can be an integer or a decimal. Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	1
WaterMarkTemplateList	array<object>	The height of the watermark image in the output video. The value can be an integer or a decimal. Integer: the height of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
WaterMarkTemplate	object	The vertical offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.
Type	string	The position of the watermark. Valid values: TopRight: the upper-right corner. TopLeft: the upper-left corner. BottomRight: the lower-right corner. BottomLeft: the lower-left corner.	Image
RatioRefer	object	The status of the watermark template. Valid values: Valid values: Normal: The watermark template is normal. Deleted: The watermark template is deleted.
Dx	string	The horizontal offset. Unit: pixel.	0.51
Width	string	The width of the watermark image. Unit: pixel.	0.36
Height	string	The height of the watermark image. Unit: pixel.	0.33
Dy	string	The timeline of the watermark.	0.2
ReferPos	string	The beginning of the time range during which the watermark is displayed. Unit: seconds. Default value: 0.	TopRight
State	string	The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.	Normal
Dx	string	The name of the watermark template.	100
Width	string	The vertical offset. Unit: pixel.	8
Height	string	The ID of the watermark template.	8
Timeline	object	The timeline of the watermark.
Start	string	The total number of returned entries.	0
Duration	string	The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	ToEND
Name	string	The width of the watermark image in the output video. The value can be an integer or a decimal. Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	example-watermark
Dy	string	The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence: Width: the width edge. Height: the height edge. Long: the long edge. Short: the short edge.	100
Id	string	The vertical offset. Unit: pixel.	88c6ca184c0e4578645b665e2a12****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber": 1,
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.2"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "ToEND"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "88c6ca184c0e4578645b665e2a12****"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history