Call the SearchWaterMarkTemplate API to search for watermark templates - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Searches for watermark templates.

Operation description

The total number of returned entries.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:SearchWaterMarkTemplate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. A maximum of 100 entries can be returned on each page. Default value: 10.	10
PageNumber	integer	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 elements

Element	Type	Description	Example
	object	The details of the watermark templates.
TotalCount	integer	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	integer	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	integer	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	object
WaterMarkTemplate	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.
	array<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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.