1. API Description
Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query the list of transcoding to adaptive bitrate streaming templates and supports paged queries by filters.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeAdaptiveDynamicStreamingTemplates. |
| 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 subapplication id. starting from december 25, 2023, if you want to access resources in the vod application (whether it is the default application or a newly created application), you must enter the application id in this field.. |
| Definitions.N |
No |
Array of Integer |
Unique id filter of transcoding to adaptive bitrate streaming templates. array length limit: 100. |
| Offset |
No |
Integer |
Pagination offset. default value: 0. |
| Limit |
No |
Integer |
Number of returned entries. default value: 10. maximum value: 100. |
| Type |
No |
String |
Template type filter. valid values:. Preset: system preset template;. Custom: user-defined template.. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
The total number of records matching the filter criteria. |
| AdaptiveDynamicStreamingTemplateSet |
Array of AdaptiveDynamicStreamingTemplate |
List of transcoding to adaptive bitrate streaming 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. |
4. Example
Example1 Querying adaptive bitrate streaming templates
https:
&Definitions.0=10001
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"AdaptiveDynamicStreamingTemplateSet": [
{
"Definition": 1001,
"Type": "Custom",
"Name": "Adaptive bitrate streaming template 1",
"Format": "HLS",
"Comment": "",
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z",
"DrmType": "",
"DisableHigherVideoResolution": 0,
"DisableHigherVideoBitrate": 0,
"StreamInfos": [
{
"RemoveVideo": 0,
"Audio": {
"Codec": "libfdk_aac",
"SampleRate": 44100,
"AudioChannel": 2,
"Bitrate": 128
},
"Video": {
"Fps": 25,
"Width": 720,
"Height": 1080,
"Codec": "libx264",
"ResolutionAdaptive": "open",
"FillType": "black",
"Bitrate": 12500,
"Vcrf": 23,
"Gop": 0
},
"RemoveAudio": 0,
"TEHDConfig": {
"MaxVideoBitrate": 10000,
"Type": "TEHD-100"
}
}
]
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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 |
Invalid parameter: Definitions. |
| InvalidParameterValue.Limit |
Invalid parameter: Limit. |
| InvalidParameterValue.Type |
Incorrect Type parameter value. |
| UnauthorizedOperation |
Unauthorized operation. |