接口功能介绍
通过本接口可查询已存在的转码模板信息。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /template/transcode/search
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 可选参数，模板的名称，模糊匹配。 | 测试模板 | |
| favorite | 否 | Boolean | 可选参数，是否为选定模板，默认全部查询。 | true | |
| type | 否 | String | 可选参数，指定模板类型，分别为 SYS（系统模板）/USER（用户自定义模板）。 | SYS | |
| pageSize | 否 | Integer | 可选参数，每页的数量，当 pageSize 与 pageIndex 为空时，表示不分页。pageIndex或pageSize只有一个传值，另一个字段会取默认值。 | 10 | |
| pageIndex | 否 | Integer | 可选参数，页码，由0开始，当 pageSize 与 pageIndex 为空时，表示不分页。 | 0 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，执行成功时，为空字符串。 | "" | |
| data | 是 | Array of Objects | 返回数据。 | -- | data |
| total | 是 | Integer | 查询结果总条数 | 2 | |
| pageCount | 是 | Integer | 查询结果总页数 | 1 |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板ID | 100000000003 | |
| name | 是 | String | 模板名称 | transcodeTemplate | |
| type | 是 | String | 类型 | SYS | |
| favorite | 是 | Boolean | 是否为选定模板 | true | |
| format | 是 | String | 转码目标文件格式 | MP4 | |
| encrytion | 是 | String | 表示是否加密目标视频 | false | |
| video | 是 | Object | 视频的转码参数 | -- | video |
| audio | 是 | Object | 音频的转码参数 | -- | audio |
| remark | 否 | String | 转码模板备注 | 模板备注 |
表 video
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| codec | 是 | String | 视频编码 | H264 | |
| bitRate | 是 | String | 视频的码率。 | 512K | |
| frameRate | 是 | Integer | 视频的帧率。 | 24 | |
| height | 是 | Integer | 目标视频的高度。 | 1024 | |
| width | 是 | Integer | 目标视频的宽度。 | 768 | |
| autoRotate | 是 | Boolean | 标识当前模板是否支持自动旋转。 | true |
表 audio
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| codec | 是 | String | 音频的编码。 | AAC | |
| bitRate | 是 | String | 音频的码率 | 128k | |
| sampleRate | 是 | Integer | 音频的频率 | 44100 |
请求示例
{
"name": "",
"favorite": false,
"type": "USER",
"pageIndex": 0,
"pageSize": 10
}
响应示例
{
"code": 0,
"message": "",
"data": [{
"templateId": "100000000003",
"name": "高清",
"type": "SYS",
"favorite": "true",
"format": "MP4",
"encrytion": "true",
"remark": "转码模板1",
"video": {
"codec": "H264",
"bitRate": "1024K",
"frameRate": "24",
"height": "1024",
"width": "768",
"autoRotate": true
},
"audio": {
"codec": "AAC",
"bitRate": "128k",
"sampleRate": "44100"
}
}, {
"templateId": "100002",
"name": "标清",
"type": "USER",
"favorite": "false",
"format": "MP4",
"encrytion": "true",
"video": {
"codec": "H264",
"bitRate": "512K",
"frameRate": "24",
"height": "1024",
"width": "768",
"autoRotate": true
},
"audio": {
"codec": "AAC",
"bitRate": "128k",
"sampleRate": "44100"
}
}
],
"total":"2",
"pageCount":"1"
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
