# 查询转码模板组 - ListTemplateGroup #### 功能介绍 查询转码模板组列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-mpc/mpc_04_0047.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-mpc/mpc_04_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | mpc:templateGroup:view | Write | - | - | - | - | #### URI GET /v1/{project_id}/template_group/transcodings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-mpc/mpc_04_0064.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_id | 否 | Array of strings | 转码模板组ID，最多10个 | | group_name | 否 | Array of strings | 转码模板组名，最多10个 | | page | 否 | Integer | 分页编号。查询指定"group_id"时，该参数无效。 默认值：0。 | | size | 否 | Integer | 每页记录数。取值范围：\[1,1000\]，指定group_id时该参数无效。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Project_Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息, 与路径参数中的项目ID相同。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_group_list | Array of [TemplateGroup] objects | 模板组信息列表。 | | total | Integer | 转码模板组总数 | 表5TemplateGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_id | String | 模板组id | | name | String | 模板组名称 | | template_ids | Array of integers | 模板组模板ID | | videos | Array of [VideoAndTemplate] objects | 视频信息列表 | | audio | [Audio] object | 音频信息 | | video_common | [VideoCommon] object | 视频通用信息 | | common | [Common] object | 通用信息 | 表6VideoAndTemplate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_id | Integer | 模板ID | | width | Integer | 视频宽度（单位：像素） - H264：范围\[32,4096\]，必须为2的倍数 - H265：范围\[320,4096\]，必须是2的倍数 说明：如果视频的宽和高仅有一个设置为0，默认非0值作为视频的短边，按照原始视频的宽高比进行等比缩放。 | | height | Integer | 视频高度（单位：像素） - H264：范围\[32,2880\]，必须为2的倍数 - H265：范围\[240,2880\]，必须是2的倍数 说明：如果视频的宽和高仅有一个设置为0，默认非0值作为视频的短边，按照原始视频的宽高比进行等比缩放。 | | bitrate | Integer | 输出平均码率。 取值范围：0或\[40,30000\]之间的整数。 单位：kbit/s 若设置为0，则输出平均码率为自适应值。 | | stream_name | String | 流名称 | 表7Audio | 参数 | 参数类型 | 描述 | |:---|:---|:---| | output_policy | String | 输出策略: - 当视频参数中的"output_policy"为"discard"，且音频参数中的"output_policy"为"transcode"时，表示只输出音频。 - 当视频参数中的"output_policy"为"transcode"，且音频参数中的"output_policy"为"discard"时，表示只输出视频。 - 当视频参数中的"output_policy"为"copy"，表示直接拷贝原始的视频，不做编解码。 - 当音频参数中的"output_policy"为"copy"，表示直接拷贝原始的音频，不做编解码。 - 同时为"discard"不合法。 - 同时为"transcode"时，表示输出音视频。 取值如下： - discard - transcode - copy | | codec | Integer | 音频编码格式。 取值如下： - 1：AAC格式。 - 2：HEAAC1格式 。 - 3：HEAAC2格式。 - 4：MP3格式 。 | | sample_rate | Integer | 音频采样率。 取值如下： - 1：AUDIO_SAMPLE_AUTO - 2：AUDIO_SAMPLE_22050（22050Hz） - 3：AUDIO_SAMPLE_32000（32000Hz） - 4：AUDIO_SAMPLE_44100（44100Hz） - 5：AUDIO_SAMPLE_48000（48000Hz） - 6：AUDIO_SAMPLE_96000（96000Hz） 说明： 当编码格式为MP3时，音频采样率取值不为6 | | bitrate | Integer | 音频码率。 取值范围：0或\[8,1000\]。 单位：kbit/s。 | | channels | Integer | 声道数。 取值如下： - 1：AUDIO_CHANNELS_1，单声道 - 2：AUDIO_CHANNELS_2，双声道 - 6：AUDIO_CHANNELS_5_1，5.1声道 当媒体的封装格式是音频格式（MP3）时，声道数不支持设为5.1声道。 | 表8VideoCommon | 参数 | 参数类型 | 描述 | |:---|:---|:---| | output_policy | String | 输出策略: - 当视频参数中的"output_policy"为"discard"，且音频参数中的"output_policy"为"transcode"时，表示只输出音频。 - 当视频参数中的"output_policy"为"transcode"，且音频参数中的"output_policy"为"discard"时，表示只输出视频。 - 当视频参数中的"output_policy"为"copy"，表示直接拷贝原始的视频，不做编解码。 - 当音频参数中的"output_policy"为"copy"，表示直接拷贝原始的音频，不做编解码。 - 同时为"discard"不合法。 - 同时为"transcode"时，表示输出音视频。 取值如下： - discard - transcode - copy | | codec | Integer | 视频编码格式。 取值如下： - 1：表示H.264。 - 2：表示H.265。 | | profile | Integer | 编码档次，建议设为3。 取值如下： - 1：VIDEO_PROFILE_H264_BASE - 2：VIDEO_PROFILE_H264_MAIN - 3：VIDEO_PROFILE_H264_HIGH - 4：VIDEO_PROFILE_H265_MAIN | | level | Integer | 编码级别。 取值如下： - 0：AUTO - 1：VIDEO_LEVEL_1_0 - 2：VIDEO_LEVEL_1_1 - 3：VIDEO_LEVEL_1_2 - 4：VIDEO_LEVEL_1_3 - 5：VIDEO_LEVEL_2_0 - 6：VIDEO_LEVEL_2_1 - 7：VIDEO_LEVEL_2_2 - 8：VIDEO_LEVEL_3_0 - 9：VIDEO_LEVEL_3_1 - 10：VIDEO_LEVEL_3_2 - 11：VIDEO_LEVEL_4_0 - 12：VIDEO_LEVEL_4_1 - 13：VIDEO_LEVEL_4_2 - 14：VIDEO_LEVEL_5_0 - 15：VIDEO_LEVEL_5_1 | | preset | Integer | 编码质量等级。 取值如下： - 1：VIDEO_PRESET_SPEED，编码快速档位 - 3：VIDEO_PRESET_HIGHQUALITY，编码高质量档位 - 4：VIDEO_PRESET_QUALITY，编码质量档位 - 5：VIDEO_PRESET_BALANCE，编码平衡档位 默认值1。 | | max_iframes_interval | Integer | I帧最大间隔 取值范围：\[2，10\]。 默认值：5。 单位：秒。 | | bframes_count | Integer | 最大B帧间隔。 取值范围： - H264：\[0，8\]，默认值为4。 - H265：\[0，7\]，默认值为7。 单位：帧。 | | frame_rate | Integer | 帧率 取值范围：0或\[5,60\]之间的整数，0表示自适应 单位：帧每秒 | 表9Common | 参数 | 参数类型 | 描述 | |:---|:---|:---| | PVC | Boolean | 是否开启高清低码功能。 取值如下： - false：关闭。（当前默认关闭） - true：开启。 (数字0表示关闭,其余正整数,负数都表示true) | | hls_interval | Integer | HLS分片间隔，仅封装格式"pack_type"取值为1或3时，该参数生效。 取值范围：\[2，10\]。 单位：秒。 | | dash_interval | Integer | DASH间隔，仅封装格式"pack_type"取值为2或3时，该参数生效。 取值范围：\[2，10\]。 单位：秒。 | | pack_type | Integer | 封装格式。 取值如下： - 1：HLS - 2：DASH - 3：HLS+DASH - 4：MP4 - 5：MP3 - 6：ADTS - 8: MOV - 9：FLV - 10：AVI 说明： pack_type设置为5和6时不能设置视频参数,设置为9时不支持多音频，设置为10时不支持H265编码。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET https://{endpoint}/v1/{project_id}/template_group/transcodings?page=0&size=10 ``` #### 响应示例 **状态码：200** 查询转码模板组成功。 ``` { "total" : 1, "template_group_list" : [ { "group_id" : "397565a34913415c91955254add0461a", "name" : "test_templageGroup", "template_ids" : [ 276195 ], "videos" : [ { "template_id" : 276195, "width" : 854, "height" : 480, "bitrate" : 500 } ], "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "video_common" : { "output_policy" : "transcode", "codec" : 1, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 4 } } ] } ``` **状态码：403** 查询转码模板组失败。 ``` { "error_code" : "MPC.10212", "error_msg" : "Operation failed." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询转码模板组成功。 | | 403 | 查询转码模板组失败。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-mpc/ErrorCode.html)。