Create image and text watermark templates with AddWatermark - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

To simplify watermark task processing, ApsaraVideo VOD consolidates complex watermark parameters such as position, size, font, and color into templates, each identified by a unique watermark template ID. Calls this operation to add an image or text watermark template.

Operation description

Call this operation to add an image watermark template (Image) or a text watermark template (Text). Image watermark templates support the following formats: static images (PNG) and animated images (GIF, APNG, MOV).
After adding a watermark template by calling this operation, call AddTranscodeTemplateGroup or UpdateTranscodeTemplateGroup to associate the watermark template with a transcoding template group for subsequent watermark transcoding.
For more information about adding image and text watermarks to videos, see Video 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:AddWatermark

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The templatetype of the watermark. Valid values: Image (default): image watermark template. Text: text watermark template.	Image
Name	string	Yes	The name of the watermark template. Only Chinese characters, letters, and digits are supported. The name can be up to 128 bytes in length. UTF-8 encoding.	Image watermark template
WatermarkConfig	string	Yes	The configuration information of the watermark (JSON string), including the display position and effect of the watermark. The configuration parameters differ between image watermarks and text watermarks. For more information about the parameter structure, see WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
FileUrl	string	No	The Object Storage Service (OSS) URL of the watermark image file (without authentication). Note Request parameter is required when you set an image watermark template (`Type` is `Image`). You can call CreateUploadAttachedMedia to upload the watermark image to ApsaraVideo VOD. The value of the `FileURL` parameter returned after the upload can be used as the value of request parameter.	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	No	The application ID. Default value: app-1000000. If you have activated the multi-application service, specify the application ID to add the watermark template to the specified application. For more information, see Multi-application service.	app-****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	The watermark template information.
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.	Image
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-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	The configuration information of the watermark (JSON string), including the display position and effect of the watermark. The configuration parameters differ between image watermarks and text watermarks. For more information about the parameter structure, see WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
Name	string	The name of the watermark template.	Image watermark template
WatermarkId	string	The ID of the watermark template. You can use this watermark template ID to associate the template with a transcoding template group, or to query, modify, delete, or set the template as the default watermark template.	9bcc8bfadb84*****109a2671d0df97

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\n      \"Width\": \"55\",\n      \"Height\": \"55\",\n      \"Dx\": \"9\",\n      \"Dy\": \"9\",\n      \"ReferPos\": \"BottomLeft\"\n}",
    "Name": "Image watermark template",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.