Updates the name and configurations of the specified watermark template.
Operation description
- You can call this operation to update the information about a watermark template based on the ID of the watermark template. For example, you can update the name and configurations of a watermark template.
- A watermark template cannot be updated if it is being used by a job that has been submitted.
QPS limit
You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
WaterMarkTemplateId | string | Yes | The ID of the watermark template that you want to update. To obtain the ID of the watermark template, you can log on to the ApsaraVideo Media Processing (MPS) console and choose Global Settings > Watermark Templates in the left-side navigation pane. | 3780bd69b2b74540bc7b1096f564**** |
Name | string | Yes | The new name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size. | example-watermark-**** |
Config | string | Yes | The updated configuration of the watermark template. The value is a JSON object. For more information, see Parameter details. | {"Width":"10","Height":"30","Dx":"10","Dy":"5","Type":"Image","Timeline":{"Start":"0","Duration":"10"}} |
Response parameters
Examples
Sample success responses
JSON
format
{
"WaterMarkTemplate": {
"Type": "Image",
"RatioRefer": {
"Dx": "0.51",
"Width": "0.36",
"Height": "0.33",
"Dy": "0.28"
},
"ReferPos": "TopRight",
"State": "Normal",
"Dx": "10",
"Width": "10",
"Height": "30",
"Timeline": {
"Start": "0",
"Duration": "10"
},
"Name": "example-watermark-****",
"Dy": "5",
"Id": "3780bd69b2b74540bc7b1096f564****"
},
"RequestId": "E558894E-40D9-57C6-B5CC-0F5CDF23614E"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|