查询转码模板列表 - ListTranscodeTemplate
功能介绍
查询转码模板列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
vod:templateGroup:list
List
-
-
-
-
URI
GET /v2/{project_id}/asset/template/transcodings
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，获取方法请参考获取项目ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| group_id | 否 | String | 模板id |
| is_default | 否 | Boolean | 是否默认模板 |
| offset | 否 | Integer | 偏移量。默认为0。指定group_id时该参数无效。 |
| limit | 否 | Integer | 每页记录数。默认为10，范围[1,100]。指定group_id时该参数无效。 |
| query_string | 否 | String | 按照模板名和描述模糊查询。指定group_id时该参数无效。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| template_group_list | Array of TransTemplateRsp objects | 模板组信息 |
| total | Integer | 总记录条数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| group_id | String | 模板组id |
| name | String | 模板组名称 |
| is_default | Boolean | 是否设置成默认转码模板 |
| type | String | 模板组类型。 |
| is_auto_encrypt | Boolean | 配置是否加密输出音视频，默认false不加密。 当前只支持加密输出HLS格式的音视频流，不会对原始上传的音视频进行加密处理。非HLS转码输出的音视频格式，此字段不可配置。开启此配置前，请参考《VOD用户指南》的“HLS加密设置”章节获取密钥URL。 |
| quality_info_list | Array of QualityInfoList objects | 画质配置信息列表 |
| watermark_template_ids | Array of strings | 绑定的水印模板组ID数组 |
| description | String | 模板介绍 |
| common | CommonInfo object | 高清低码开关，高清低码Version，编码格式多路共同参数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| video | VideoInfo object | 模板视频信息。video和audio至少配置一个参数。 |
| audio | AudioInfo object | 模板音频信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| quality | String | 画质 |
| width | Integer | 视频宽度 H264编码：0或[32,4096]之间2的整数倍 H265编码：0或[160,4096]之间2的整数倍 |
| height | Integer | 视频高度 H264编码：0或[32,2880]之间2的整数倍 H265编码：0或[160,2880]之间2的整数倍 |
| bitrate | Integer | 平均码率，单位：kbit/s。 参考取值范围：0或[40,30000]之间的整数。 |
| frame_rate | Integer | 帧率，单位是帧每秒。 取值范围：[0-75]之间的整数，小于5帧或大于60帧代表自适应。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| sample_rate | String | 音频采样率（有效值范围） |
| bitrate | Integer | 音频码率（单位：Kbps） |
| channels | String | 声道数（有效值范围） |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pvc | Boolean | 高清低码开关 |
| video_codec | String | 视频编码格式 |
| audio_codec | String | 音频编码格式 |
| is_black_cut | Boolean | 黑边剪裁类型，默认false不开启黑边剪裁 |
| format | String | 转码格式 |
| hls_interval | Integer | 分片时长，范围2-10（默认为5秒） |
| upsample | Boolean | 上采样开关，开启后可以提升视频的分辨率，增加采样点的数量，默认值:false，表示不开启上采样。 |
| adaptation | String | 转码后的片源分辨率自适应方式。 取值如下： |
| preset | Integer | 编码质量等级，取值[0,2] 0表示默认方式，1表示转码效率优先，2表示转码质量优先。 |
| max_iframes_interval | Integer | I帧最大间隔，取值范围：[2，10]。默认值：5，单位秒。 |
| hls_audio_separate | Boolean | 转码后音频是否独立存储。 |
| hls_segment_type | String | HLS分片的封装格式，目前支持TS和FMP4，默认TS格式 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询转码模板
GET https://{endpoint}/v2/{project_id}/asset/template/transcodings?group_id={group_id} 响应示例
状态码：200
处理成功返回。
{
"template_group_list" : [ {
"group_id" : "9751249d25f14587b212544d6fd8dcf8",
"name" : "non_transcoding_template_group",
"is_default" : false,
"type" : "non_transcoding_template_group",
"is_auto_encrypt" : false,
"quality_info_list" : [ {
"video" : {
"quality" : "UNKNOW",
"width" : 0,
"height" : 0,
"bitrate" : 0,
"frame_rate" : 0
},
"audio" : null
} ],
"watermark_template_ids" : null,
"description" : null,
"common" : {
"pvc" : false,
"is_black_cut" : false,
"format" : "UNKNOW",
"upsample" : false,
"adaptation" : "NONE",
"video_codec" : null,
"audio_codec" : "AAC",
"hls_interval" : 0
}
} ],
"total" : 0
} 状态码：403
处理失败返回。
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 处理成功返回。 |
| 403 | 处理失败返回。 |
错误码
请参见错误码。
