tencent cloud



Last updated: 2024-03-27 16:09:54

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    Describe Just In Time Transcode 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: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Names.N No Array of String Template name filter condition, array length limit: 100.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Type No String Template type filter conditions, optional values:
  • Preset: system preset task flow template;
  • Custom: user-defined task flow template.
  • Offset No Integer Paging offset, default value: 0.
    Limit No Integer Returns the number of records, default value: 10, maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The total number of records matching the filter criteria.
    JustInTimeTranscodeTemplateSet 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 Describe Just In Time Transcode Templates

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeJustInTimeTranscodeTemplates
    <Public request parameters>
        "Names": [

    Output Example

        "Response": {
            "TotalCount": 1,
            "JustInTimeTranscodeTemplateSet": [
                    "Type": "Custom",
                    "Name": "test",
                    "Comment": "comment",
                    "VideoConfigure": {
                        "Width": 720,
                        "Height": 1080,
                        "Bitrate": 10000,
                        "ResolutionAdaptive": "open"
                    "WatermarkConfigure": {
                        "Switch": "ON",
                        "Url": "http://example.com/aa.png",
                        "Width": "10%",
                        "Height": "10%",
                        "XPos": "10%",
                        "YPos": "10%"
            "RequestId": "abc"

    5. Developer Resources


    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
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    RequestLimitExceeded Too many requests.
    ResourceNotFound.UserNotExist The user does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support