Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query user-defined watermark templates, and the pagination query is supported based on conditions.
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: DescribeWatermarkTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD services from December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Type | No | String | Watermark type filter. Valid values: |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Definitions.N | No | Array of Integer | Filtering condition for the unique identifier of the watermark template. The array length cannot exceed 100. |
| Limit | No | Integer | Number of returned entries |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| WatermarkTemplateSet | Array of WatermarkTemplate | List of watermark template details. |
| 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.intl.tencentcloudapi.com/?Action=DescribeWatermarkTemplates
&Definitions.0=1001
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"WatermarkTemplateSet": [
{
"Definition": 1001,
"Type": "image",
"Name": "Sample structure to be refined",
"Comment": "Test template",
"XPos": "10%",
"YPos": "10%",
"ImageTemplate": {
"ImageUrl": "http://example.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/aa.jpeg",
"Width": "80%",
"Height": "80%",
"RepeatType": "repeat",
"Transparency": 0
},
"TextTemplate": {
"FontType": "arial.ttf",
"FontSize": "16px",
"FontColor": "0xFF0000",
"FontAlpha": 1
},
"SvgTemplate": {
"Width": "10px",
"Height": "10px"
},
"CoordinateOrigin": "topLeft",
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
}
],
"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. |
| InvalidParameterValue.Definitions | Parameter error: Definitions. |
| InvalidParameterValue.Limit | Parameter error: Limit. |
| InvalidParameterValue.Type | Type parameter value error. |
| ResourceNotFound.TemplateNotExist | Resource does not exist: template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan