Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to search for a list of title and trailer templates.
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: DescribeHeadTailTemplates. |
| 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 after 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). |
| Definitions.N | No | Array of Integer | Opening and ending template IDs, with the maximum array length of 100. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| HeadTailTemplateSet | Array of HeadTailTemplate | Header and trailer template detail list. |
| 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. |
Query the list of Title and Trailer Templates
https://vod.intl.tencentcloudapi.com/?Action=DescribeHeadTailTemplates
&Definitions.0=10000
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1",
"HeadTailTemplateSet": [
{
"Definition": 10000,
"HeadCandidateSet": [
"123xxx000"
],
"FillType": "black",
"Name": "Template number",
"Comment": "Template description",
"TailCandidateSet": [
"1230xxx99"
],
"CreateTime": "2023-01-01T10:00:00Z",
"UpdateTime": "2023-01-01T10:00:00Z"
}
]
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback