Query all image and text watermark templates with ListWatermark - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Invokes this operation to query the parameter settings of all image watermark templates and text watermark templates that have been added in the current service region, including the position, size, and display time of image watermarks, and the content, font, color, position, and other parameter settings of text watermarks.

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

vod:ListWatermark

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID. Default value: app-1000000. If the multi-application service is enabled, you can specify an application ID to query watermark templates under the specified application. If you do not specify this parameter, watermark templates under all applications are returned. For more information, see Multi-application.	app-****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfos	array<object>	The watermark template information.
	object
CreationTime	string	The time when the watermark template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2018-11-07T09:05:52Z
Type	string	The type of the watermark template. Valid values: Image: image watermark template. Text: text watermark template.	Text
IsDefault	string	Indicates whether the watermark template is the default template. Valid values: Default: the default watermark template. NotDefault: not the default watermark template.	NotDefault
FileUrl	string	The URL of the watermark file (OSS URL or CDN URL). Note This parameter is returned only for image watermark templates.	https://outin-3262681cd***89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozB**
AppId	string	The application ID.	app-****
WatermarkConfig	string	The configuration information of the watermark (JSON string), including the display position and effect of the watermark. The configuration parameters for image watermarks and text watermarks are different. For more information about the parameter structure, see WatermarkConfig.	{"FontColor": "Blue","FontSize": 80,"Content": " watermark test"}
Name	string	The name of the watermark template.	Text watermark test
WatermarkId	string	The ID of the watermark template.	9bcc8bfadb843*****109a2671d0df97

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfos": [
    {
      "CreationTime": "2018-11-07T09:05:52Z",
      "Type": "Text",
      "IsDefault": "NotDefault",
      "FileUrl": "https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****",
      "AppId": "app-****",
      "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80,\"Content\": \" watermark test\"}",
      "Name": "Text watermark test",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.