搜索轉碼模板
更新時間 2023-10-16 10:37:09
最近更新時間: 2023-10-16 10:37:09
分享文章
通過本接口可查詢已存在的轉碼模板信息。
接口功能介紹
通過本接口可查詢已存在的轉碼模板信息。
接口約束
本接口的單用戶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錯誤碼請參考 錯誤碼說明。
