有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

根据转码模板唯一标识,获取转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及系统预置转码模板

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTranscodeTemplates。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:123
Definitions.N Array of Integer 转码模板唯一标识过滤条件,数组长度限制:100。
示例值:["10\n"]
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:Custom
    ContainerType String 封装格式过滤条件,可选值:
  • Video:视频格式,可以同时包含视频流和音频流的封装格式板;
  • PureAudio:纯音频格式,只能包含音频流的封装格式。

  • 示例值:Video
    TEHDType String 极速高清过滤条件,用于过滤普通转码或极速高清转码模板,可选值:
  • Common:普通转码模板;
  • TEHD:极速高清模板。

  • 示例值:Common
    Offset Integer 分页偏移量,默认值:0。
    示例值:0
    Limit Integer 返回记录条数,默认值:10,最大值:100。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    TranscodeTemplateSet Array of TranscodeTemplate 转码模板详情列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取转码模板

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeTranscodeTemplates
    &Definitions.0=10
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "TranscodeTemplateSet": [
                {
                    "Definition": "1008",
                    "Container": "mp4",
                    "Name": "模板1",
                    "Comment": "test",
                    "Type": "Custom",
                    "RemoveVideo": 0,
                    "RemoveAudio": 0,
                    "SegmentType": "",
                    "ContainerType": "Video",
                    "TEHDConfig": null,
                    "VideoTemplate": {
                        "Codec": "libx264",
                        "Fps": 24,
                        "FillType": "black",
                        "Bitrate": 256,
                        "CodecTag": "hvc1",
                        "Gop": 0,
                        "Vcrf": 23,
                        "PreserveHDRSwitch": "OFF",
                        "ResolutionAdaptive": "open",
                        "Width": 0,
                        "Height": 0
                    },
                    "AudioTemplate": {
                        "Codec": "libfdk_aac",
                        "Bitrate": 48,
                        "SampleRate": 48000,
                        "AudioChannel": 2
                    },
                    "CreateTime": "2018-10-01T10:00:00Z",
                    "UpdateTime": "2018-10-01T10:00:00Z"
                }
            ],
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InvalidParameterValue.ContainerType 参数值错误:ContainerType。
    InvalidParameterValue.Definitions 参数错误:Definitions。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.TEHDType 参数值错误:TEHD Type 无效。
    InvalidParameterValue.Type Type 参数值错误。
    ResourceNotFound.TemplateNotExist 资源不存在:模板不存在。
    UnauthorizedOperation 未授权操作。