UpdateWatermark - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Modifies the name and configurations of a watermark template after you create a watermark template.

Operation description

You can modify the name and configurations of the watermark template after you call the AddWatermark operation to create a watermark template.
You cannot call this operation to change the image in an image watermark template.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the watermark template to which you want to change. Only letters and digits are supported. The name cannot exceed 128 bytes. The value must be encoded in UTF-8.	test
WatermarkId	string	Yes	The ID of the watermark template. You can specify only one watermark template ID. You can obtain the ID by using one of the following methods: Obtain the watermark template ID from the response to the AddWatermark operation that you call to create a watermark template. Obtain the watermark template ID from the response to the ListWatermark operation that you call to query all watermark templates within your account.	af2afe4761992c*****bd947dae97337
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","Type":"Image"}

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-06T08:03:17Z
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. 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-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 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 .	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
Name	string	The name of the watermark template.	image watermark test
WatermarkId	string	The ID of the watermark template.	505e2e287ea*****ecfddd386d384

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Text",
    "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\":\"BottonLeft\",\"Type\":\"Image\"}",
    "Name": "image watermark test",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history