Domain name for API request: vod.tencentcloudapi.com.
This API is used to modify a custom watermarking template. The watermark type cannot be modified.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyWatermarkTemplate. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
Region | No | String | Common Params. This parameter is not required. |
Definition | Yes | Integer | Unique ID of watermarking template. |
SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Name | No | String | Watermarking template name. Length limit: 64 characters. |
Comment | No | String | Template description. Length limit: 256 characters. |
CoordinateOrigin | No | String | Origin position. Valid values: |
XPos | No | String | The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:XPos of the watermark will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width;XPos of the watermark will be the specified px; for example, 100px means that XPos is 100 px. |
YPos | No | String | The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:YPos of the watermark will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height;YPos of the watermark will be the specified px; for example, 100px means that YPos is 100 px. |
ImageTemplate | No | ImageWatermarkInputForUpdate | Image watermarking template. This field is valid only for image watermarking templates. |
TextTemplate | No | TextWatermarkTemplateInputForUpdate | Text watermarking template. This field is valid only for text watermarking templates. |
SvgTemplate | No | SvgWatermarkInputForUpdate | SVG watermarking template. This field is only valid for SVG watermarking templates. |
Parameter Name | Type | Description |
---|---|---|
ImageUrl | String | Image watermark address. This field has a value only when ImageTemplate.ImageContent is not empty.Note: this field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vod.tencentcloudapi.com/?Action=ModifyWatermarkTemplate
&Definition=1001
&Name=Template 2
&<Common request parameters>
{
"Response": {
"ImageUrl": null,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.InvalidVodUser | The VOD service is not activated. |
InternalError | Internal error. |
InternalError.UploadWatermarkError | Internal error: failed to upload watermark image. |
InvalidParameterValue.Comment | Invalid parameter: template description. |
InvalidParameterValue.CoordinateOrigin | Incorrect parameter value: CoordinateOrigin. |
InvalidParameterValue.Height | Invalid parameter: height. |
InvalidParameterValue.ImageContent | Invalid ImageContent . |
InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
InvalidParameterValue.RepeatType | Invalid parameter: invalid RepeatType . |
InvalidParameterValue.SvgTemplateHeight | Incorrect parameter value: SVG height. |
InvalidParameterValue.SvgTemplateWidth | Incorrect parameter value: SVG width. |
InvalidParameterValue.TextAlpha | Invalid parameter: text transparency. |
InvalidParameterValue.Type | Incorrect Type parameter value. |
InvalidParameterValue.Width | Invalid parameter: width. |
InvalidParameterValue.XPos | The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported. |
InvalidParameterValue.YPos | The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported. |
ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?