Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a user-defined digital watermark template.
A maximum of 20 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: CreateBlindWatermarkTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Type | Yes | String | Digital watermark type. Valid values: |
| TextContent | Yes | String | Text content of the digital watermark. The length cannot exceed 64 characters. After NAGRA watermark templates are created, the text content cannot be modified. |
| SubAppId | No | Integer | VOD application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (default application or newly created application). |
| Name | No | String | Digital watermark template name, which supports Chinese, English, digits, underscores (_), hyphens (-), and periods (.). The length cannot exceed 64 characters. |
| Comment | No | String | Description information of the digital watermark template. The length cannot exceed 256 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of the digital watermark template. |
| 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. |
This example shows you how to create a digital watermark template.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlindWatermarkTemplate
<Common request parameters>
{
"Name": "Digital watermark template 1",
"Comment": "Digital watermark",
"Type": "blind-nagra",
"TextContent": "Digital watermark text"
}
{
"Response": {
"Definition": 10,
"RequestId": "93dda61a-c2c5-465d-a78c-0860997fb01b"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InternalError.GenDefinition | Internal error: failed to generate template ID. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
文档反馈