DescribeJustInTimeTranscodeTemplates

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to search the transcoding template detail list according to the name, template type, or unique identifier of the just-in-time transcoding template. The returned results include all eligible custom templates and preset templates.

A maximum of 20 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.

2. Input Parameters

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: DescribeJustInTimeTranscodeTemplates.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Specifies the site ID.
Filters.N	No	Array of Filter	The maximum number of Filters is 20. the upper limit for Filters.Values is 20. if this parameter is left empty, it returns the authorized just-in-time transcoding templates in the current ZoneId by default. detailed filter criteria: template-name: filter by template name in batch. example: mytemplate; template-type: filter by template type in batch. example: preset or custom. template-id: filter by template id in batch. example: C1LZ7982VgTpYhJ7M. empty by default.
SortBy	No	String	Sorting field. valid values: createTime: template creation time. default value: createTime.
SortOrder	No	String	Sorting method. valid values: `asc`: ascending order; `desc`: descending order. default value: `desc`.
Offset	No	Integer	Paging offset. Default value: 0.
Limit	No	Integer	Number of returned entries. default value: 20. maximum value: 1000.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of records that meet filter conditions.
TemplateSet	Array of JustInTimeTranscodeTemplate	Template details 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.

4. Example

Example1 Obtaining Transcoding Templates

This example shows you how to obtain a transcoding template by its name.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJustInTimeTranscodeTemplates
<Common request parameters>

{
    "ZoneId": "zone-djuqmq",
    "Filters": [
        {
            "Name": "template-name",
            "Values": [
                "myTemplate"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 100
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "TemplateSet": [
            {
                "TemplateId": "C1LZ7982VgTpYhJ7M",
                "TemplateName": "myTemplate",
                "Comment": "MyTranscodeTemplate",
                "Type": "Custom",
                "VideoStreamSwitch": "on",
                "AudioStreamSwitch": "on",
                "VideoTemplate": {
                    "Codec": "H.264",
                    "Fps": 24,
                    "FillType": "black",
                    "Bitrate": 2048,
                    "ResolutionAdaptive": "open",
                    "Width": 0,
                    "Height": 0
                },
                "AudioTemplate": {
                    "Codec": "libfdk_aac",
                    "AudioChannel": 2
                },
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            }
        ],
        "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

Tencent Cloud CLI 3.0

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.ProductDiscontinued	The product will already be discontinued. operation denied.
FailedOperation.ProductNotActivated	This product is not enabled. please enable it and try again.
InternalError	Internal error.
InvalidFilter	Invalid Filter
InvalidParameterValue	Invalid parameter value.
InvalidParameterValue.ZoneNotFound	No corresponding site. please ensure correct information entry.
InvalidParameterValue.ZonePaused	The site is disabled. check current site status.
MissingParameter	Missing parameters.
UnauthorizedOperation	Unauthorized operation.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Obtaining Transcoding Templates
5. Developer Resources
SDK
Command Line Interface
6. Error Code