Call QueryWaterMarkTemplateList to query watermark templates - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries the details of specified watermark templates by template ID.

Operation description

A maximum of 10 watermark templates can be queried at a time.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

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:QueryWaterMarkTemplateList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WaterMarkTemplateIds	string	Yes	The IDs of the watermark templates to query. To obtain the template IDs, log on to the ApsaraVideo Media Processing (MPS) console and choose Global Settings > Watermark Templates in the left-side navigation pane. You can query up to 10 watermark templates at a time. Separate multiple IDs with commas (,).	3780bd69b2b74540bc7b1096f564****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	17079AF5-6276-51A9-B755-D26594C93F3C
NonExistWids	object
String	array	The IDs of the templates that do not exist.
	string	The IDs of the watermark templates that do not exist. Not returned if all specified watermark templates are found.	72dfa5e679ab4be9a3ed9974c736****
WaterMarkTemplateList	object
WaterMarkTemplate	array<object>	The details of the watermark templates.
	array<object>	The response parameters.
Type	string	The type of the watermark. Valid values: Image: an image watermark. Text: a text watermark. Note Only watermarks of the Image type are supported.	Image
RatioRefer	object	The reference edges used to calculate the Height, Width, Dx, and Dy parameters. When these parameter values are decimals between 0 and 1, they are calculated relative to the following edges in sequence: Width: the width edge. Height: the height edge. Long: the long edge. Short: the short edge.
Dx	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.	0.51
Width	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.	0.36
Height	string	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.	0.33
Dy	string	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.	0.4
ReferPos	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.	TopRight
State	string	The status of the watermark template. Valid values: Normal: The watermark template is normal. Deleted: The watermark template is deleted.	Normal
Dx	string	The horizontal offset. Unit: pixel.	100
Width	string	The width of the watermark image. Unit: pixel.	8
Height	string	The height of the watermark image. Unit: pixel.	8
Timeline	object	The timeline of the watermark.
Start	string	The beginning of the time range during which the watermark is displayed. Unit: seconds. Default value: 0.	0
Duration	string	The display duration of the watermark. Default value: ToEND, which indicates that the watermark is displayed until the video ends.	10
Name	string	The name of the watermark template.	example-watermark
Dy	string	The vertical offset. Unit: pixel.	100
Id	string	The ID of the watermark template.	3780bd69b2b74540bc7b1096f564****

Examples

Success response

JSON format

{
  "RequestId": "17079AF5-6276-51A9-B755-D26594C93F3C",
  "NonExistWids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.4"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "10"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "3780bd69b2b74540bc7b1096f564****"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.