搜索轉碼任務
更新時間 2025-04-16 09:55:25
最近更新時間: 2025-04-16 09:55:25
分享文章
通過本接口向云點播查詢轉碼任務進行狀態。
接口功能介紹
用戶可在點播模式下通過本接口向云點播查詢轉碼任務。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /task/search
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| status | 否 | String | 任務狀態，分別為 WORKING（工作中）、DONE（完成）、WARNING（執行結束）、FAIL（失敗）。 | DONE | |
| createTime | 否 | Object | 用戶的創建時間。 | createTime | |
| pageSize | 是 | Integer | 必填參數，每頁的數量，由于任務數量多，請必須傳入該參數，該參數最大數值為1000。 | ||
| pageIndex | 是 | Integer | 必填參數，頁碼，由0開始。 |
表 createTime
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| from | 否 | String | 用戶的創建時間，格式為 yyyy-MM-dd HH:mm:ss。 |
2019-05-15 03:15:30 | |
| to | 否 | String | 用戶的創建時間，格式為 yyyy-MM-dd HH:mm:ss。 |
2019-05-15 03:15:31 |
響應參數
返回值為一個 JsonArray，即使結果僅有一條也一樣。
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼 | 0 | |
| message | 是 | String | 錯誤文本信息，創建成功時，為空字符串。 | "" | |
| data | 是 | Array of Objects | 返回數據 | data |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| taskId | 是 | String | 任務id | 0001#1a619cdd3f19406794f9663ee246cb7e | |
| callback | 否 | String | 回調地址 | //callback.daliqc.cn/callback | |
| callbackMessage | 否 | String | 回調信息 | 詳見下文示例 | |
| status | 是 | String | 狀態 | DONE | |
| createTime | 是 | String | 創建時間 | 2019-06-16 13:34:03 | |
| videoId | 是 | String | 視頻id | 34c71dba-f280-4f5e-a05f-f4daed837fef | |
| transcodeTemplateId | 是 | Integer | 轉碼模板id | 100000000003 | |
| watermarkId | 否 | Integer | 水印模板id | 100000000003 |
請求示例
請求體body
{
"status": "DONE",
"createTime": {
"from": "2019-05-15 03:15:30",
"to": "2019-05-15 03:15:30"
},
"pageSize": 10,
"pageIndex": 0
}
響應示例
{
"code": 0,
"message": "",
"data": [{
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e",
"callback": "//callback.daliqc.cn/callback",
"callbackMessage": "{\"code\":\"0\",\"message\":\"任務成功\",\"successful\":true,\"trace\":{\"node\":\"10.xx.xx.xx\",\"xTranscodeAddr\":\"xs-shanghai-1\"},\"warning\":false}",
"status": "DONE",
"createTime": "2019-06-16 13:34:03",
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fef",
"transcodeTemplateId": 100000000003,
"watermarkId": 100000000003
}, {
"taskId": "0001#1a619cdd3f19406794f9663ee246cb7e",
"callback": "//callback.daliqc.cn/callback",
"status": "WORKING",
"createTime": "2019-06-16 13:36:03",
"videoId": "34c71dba-f280-4f5e-a05f-f4daed837fee",
"transcodeTemplateId": 100000000003
}
]
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
