查询转码模板 - ListTemplate
功能介绍
查询用户自定义转码配置模板。
支持指定模板ID查询,或分页全量查询。转码配置模板ID,最多10个。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
mpc:transcodeTemplate:view
List
-
-
-
-
URI
GET /v1/{project_id}/template/transcodings
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
template_id |
否 |
Array of integers |
自定义转码模板ID,最多10个 |
|
page |
否 |
Integer |
分页编号。查询指定“task_id”时,该参数无效。 默认值:0。 |
|
size |
否 |
Integer |
每页记录数。取值范围:[1,1000],指定template_id时该参数无效 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_array |
Array of TemplateInfo objects |
转码模板 |
|
total |
Integer |
转码模板总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_name |
String |
转码模板名称。 |
|
video |
Video object |
视频信息。 |
|
audio |
Audio object |
音频信息。 |
|
common |
Common object |
通用信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
PVC |
Boolean |
是否开启高清低码功能。 取值如下: (数字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 |
封装格式。 取值如下:
说明:
pack_type设置为5和6时不能设置视频参数,设置为9时不支持多音频,设置为10时不支持H265编码。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/templates/transcoding?template_id=80985
响应示例
状态码:200
查询转码模板成功。
{
"template_array" : [ {
"template_id" : 80985,
"template" : {
"template_name" : "test_template",
"video" : {
"output_policy" : "transcode",
"codec" : 1,
"bitrate" : 0,
"profile" : 3,
"level" : 15,
"preset" : 3,
"max_iframes_interval" : 5,
"bframes_count" : 4,
"frame_rate" : 0,
"width" : 0,
"height" : 0,
"black_cut" : 0
},
"audio" : {
"output_policy" : "transcode",
"codec" : 1,
"bitrate" : 0,
"sample_rate" : 1,
"channels" : 2
},
"common" : {
"PVC" : false,
"hls_interval" : 5,
"dash_interval" : 5,
"pack_type" : 1
}
}
} ],
"total" : 1
}
状态码:403
查询转码模板失败。
{
"error_code" : "MPC.10212",
"error_msg" : "Operation failed."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询转码模板成功。 |
|
403 |
查询转码模板失败。 |
错误码
请参见错误码。