AddWatermark - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Creates an image or text watermark template. ApsaraVideo VOD allows you to create watermark templates to reuse your parameter configurations such as watermark position, size, font, and color. Each watermark template is assigned a unique ID. This simplifies the processing of watermark tasks.

Operation description

You can call this operation to create an Image watermark template or a Text watermark template. You can use static images in the PNG format or dynamic images in the GIF, APNG, and MOV formats as image watermarks.
After you call this operation to create a watermark template, you must call the AddTranscodeTemplateGroup or UpdateTranscodeTemplateGroup operation to associate the watermark template with a transcoding template group. This way, you can add watermarks to videos during transcoding.
For more information, see Video watermarks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
vod:AddWatermark		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The type of the watermark template. Valid values: Image (default): image watermark template Text: text watermark template	Text
Name	string	Yes	The name of the watermark template. Only letters and digits are supported. The name cannot exceed 128 bytes. The value must be encoded in UTF-8.	watermark
WatermarkConfig	string	Yes	The configuration information of the watermark such as the display position and special effects. The value must be a JSON string. The configuration parameters for image and text watermarks are different. For more information about the parameter structure, see WatermarkConfig .	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft"}
FileUrl	string	No	The URL of the watermark file. The URL must be an Object Storage Service (OSS) URL and cannot contain the information used for URL signing. Note This parameter is required if you set `Type` to `Image`. You can obtain the URL from the `FileURL` parameter in the response to the CreateUploadAttachedMedia operation that you call to upload the watermark image to ApsaraVideo VOD.	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	No	The ID of the application. Default value: app-1000000. If you have activated the multi-application service, specify the ID of the application to add the watermark template in the specified application. For more information, see Overview .	app-****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	The information about the watermark template.
CreationTime	string	The time when the watermark template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-07T09:05:52Z
Type	string	The type of the watermark template. Image: image watermark template Text: text watermark template	Text
IsDefault	string	Indicates whether the watermark template is the default one. Valid values: Default NotDefault	NotDefault
FileUrl	string	The URL of the watermark file. The URL is an Object Storage Service (OSS) URL or an Alibaba Cloud 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 such as the display position and special effects. The value is a JSON string. The configuration parameters for image 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.	9bcc8bfadb84*****109a2671d0df97

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Text",
    "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": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"watermark test\" }",
    "Name": " text watermark test",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

Error codes

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

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
NoSuchResource	The specified resource %s does not exist.	404	The error message returned because the user-related resource does not exist. %s indicates the specific resource information.