調用本介面查詢視頻重新整理或預熱任務的任務狀態、篩選策略等任務資訊。
介面說明
使用說明
支援查詢重新整理或預熱任務下所有音/視頻的任務資訊或指定查某一個音/視頻的任務資訊。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。更多資訊,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:GetMediaRefreshJobs |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| MediaRefreshJobId |
string |
是 |
音/視頻重新整理或預熱的任務 ID,為提交音視頻重新整理或預熱任務介面返回參數 MediaRefreshJobId 的值。 |
41d465e31957**** |
| MediaId |
string |
否 |
音/視頻 ID,為提交音視頻重新整理或預熱任務時傳入的 若不傳入本參數,則查詢 |
ca3a8f6e4957b658067095869**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
25818875-5F78-4AF6-D7393642CA58**** |
| MediaRefreshJobs |
array<object> |
音/視頻重新整理或預熱任務資訊列表。 |
|
|
object |
音/視頻重新整理或預熱任務詳情。 |
||
| MediaRefreshJobId |
string |
音/視頻重新整理或預熱的任務 ID。 |
41d465e31957**** |
| MediaId |
string |
音/視頻 ID。 |
ca3a8f6e4957b658067095869**** |
| TaskType |
string |
任務類型。取值:
|
Preload |
| FilterPolicy |
string |
播放流的篩選策略。JSON 格式,內容為提交音視頻重新整理或預熱任務介面的請求參數。 |
{"Formats":"mp4,m3u8", "Definitions":"HD,SD", " StreamType":"video", "ResultType":"Single", " SliceFlag":false, "SliceCount": 3} |
| Status |
string |
任務狀態。取值:
|
success |
| SuccessPlayUrls |
string |
成功被重新整理或預熱的播放 URL。 |
https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8 |
| TaskIds |
string |
播放 URL 的重新整理或預熱的任務 ID,一個 URL 對應一個任務 ID。該任務 ID 用於 DescribeVodRefreshTasks 介面查詢每個播放 URL 的重新整理或預熱狀態。 |
70422****,9524**** |
| ErrorCode |
string |
錯誤碼。 當提交重新整理或預熱任務失敗時會有該欄位。 |
PreloadQueueFull |
| ErrorMessage |
string |
錯誤資訊。 當提交重新整理或預熱任務失敗時會有該欄位。 |
Preload queue is full, please try again later! |
| UserData |
string |
提交重新整理或預熱任務時傳入的 UserData 資訊。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
| GmtCreate |
string |
任務建立時間。 |
2022-05-20 08:23:22 |
| GmtModified |
string |
任務修改時間。 |
2022-05-21 08:23:22 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"MediaRefreshJobs": [
{
"MediaRefreshJobId": "41d465e31957****",
"MediaId": "ca3a8f6e4957b658067095869****",
"TaskType": "Preload",
"FilterPolicy": "{\"Formats\":\"mp4,m3u8\", \"Definitions\":\"HD,SD\", \" StreamType\":\"video\", \"ResultType\":\"Single\", \" SliceFlag\":false, \"SliceCount\": 3}",
"Status": "success",
"SuccessPlayUrls": "https://shenzhen.****.aliyuncdn.com/74401a4f546007bf845cd8840****.m3u8,https://shenzhen.****.aliyuncdn.com/24041e7d13582d86604d8****.m3u8",
"TaskIds": "70422****,9524****",
"ErrorCode": "PreloadQueueFull",
"ErrorMessage": "Preload queue is full, please try again later!",
"UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"}, \"Extend\":{\"localId\":\"xxx\",\"test\":\"www\"}}",
"GmtCreate": "2022-05-20 08:23:22",
"GmtModified": "2022-05-21 08:23:22"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。