Modify Watermark Template Name and Configuration via API - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Modifies the name and watermark configuration (WatermarkConfig) of an image and text watermark template that was added by calling the AddWatermark operation.

Operation description

After you invoke AddWatermark to add an image and text watermark template, you can invoke this operation to modify the name and watermark configuration of the template.
This operation does not support replacing the image in an image watermark template or modifying the template across templatetypes (such as changing an image watermark template to a text watermark template).

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The new 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.	test
WatermarkId	string	Yes	The ID of the image and text watermark template to modify. Only a single watermark template ID is supported. You can obtain the ID by using one of the following methods: The ID is returned after you call the AddWatermark operation to add an image and text watermark template. The ID is returned after you call the ListWatermark operation to query the list of image and text watermark templates.	af2afe4761992c*****bd947dae97337
WatermarkConfig	string	Yes	The configuration information of the image and text watermark (JSON character string), including the watermark display position and watermark effect. The configuration parameters for image watermarks and text watermarks are different. For details about the parameter structure, see WatermarkConfig. Note Modifying across templatetypes is not supported. You can invoke the GetWatermark operation to query the type of the watermark template before modifying the configuration.	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottomLeft"}

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-06T08:03:17Z
Type	string	The type of the watermark template. Valid values: Image: image watermark template. Text: text watermark template.	Image
IsDefault	string	Indicates whether the template is the default image and text watermark template. Valid values: Default: the default image and text watermark template. NotDefault: not the default image and text watermark template.	NotDefault
FileUrl	string	The URL of the watermark file (OSS address or CDN address). Note This parameter is returned only for image watermark templates.	https://outin-32**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 image and text watermark (JSON string), including the watermark display position and watermark effect. The configuration parameters for image watermarks and text watermarks are different. 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.	test
WatermarkId	string	The ID of the watermark template.	505e2e287ea*****ecfddd386d384

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"Width\":\"55\",\"Height\":\"55\",\"Dx\":\"9\",\"Dy\":\"9\",\"ReferPos\":\"BottomLeft\"}",
    "Name": "test",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.