边缘安全加速平台 EO 获取即时转码模版列表

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

根据即时转码模板名字、模板类型或唯一标识，获取即时转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及预置模板。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJustInTimeTranscodeTemplates。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
ZoneId	是	String	站点ID。
Filters.N	否	Array of Filter	过滤条件，Filters 的上限为 20，Filters.Values 的上限为 20。该参数不填写时，默认返回当前 ZoneId 下有权限的即时转码模板。详细的过滤条件如下： template-name：按照模版名批量进行过滤。例如：mytemplate； template-type：按照模板类型批量进行过滤。例如：preset 或 custom。 template-id：按照模板 ID 批量进行过滤。例如：C1LZ7982VgTpYhJ7M。默认为空。
SortBy	否	String	排序字段，取值有： createTime：模板创建时间。默认值为：createTime。
SortOrder	否	String	排序方式，取值有： asc：升序方式； desc：降序方式。默认值为：desc。
Offset	否	Integer	分页偏移量，默认值：0。
Limit	否	Integer	返回记录条数，默认值：20，最大值：1000。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合过滤条件的记录总数。
TemplateSet	Array of JustInTimeTranscodeTemplate	模板详情列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取转码模板

根据模板名获取转码模板。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJustInTimeTranscodeTemplates
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ProductDiscontinued	该产品即将下架，操作被拒绝。
FailedOperation.ProductNotActivated	没有开通本产品，请开通后再尝试。
InternalError	内部错误。
InvalidFilter	无效的过滤器
InvalidParameterValue	参数取值错误。
InvalidParameterValue.ZoneNotFound	没有对应的站点，请确保站点信息填写正确。
InvalidParameterValue.ZonePaused	站点已停用，请检查当前站点状态。
MissingParameter	缺少参数错误。
UnauthorizedOperation	未授权操作。

获取即时转码模版列表

本页目录：