調用本介面通過音視頻ID發起音視頻重新整理或預熱任務。
介面說明
ApsaraVideo for VOD提供資源的重新整理和預熱功能,通過重新整理功能,您可以刪除 CDN 節點上已經緩衝的資源,並強制 CDN 節點回來源站點擷取最新資源;通過預熱功能,您可以在業務高峰前預熱熱門資源,提前將熱門資源下載並緩衝到 CDN 節點,提高資源的訪問效率。
本介面直接通過音/視頻 ID 發起重新整理或預熱任務,且支援篩選播放流格式及清晰度等,滿足使用者按需選擇合適的播放流進行重新整理預熱的需求。
最多支援一次發起 20 個音/視頻的重新整理或預熱任務。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。更多資訊,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:RefreshMediaPlayUrls |
update |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| MediaIds |
string |
是 |
需要重新整理或預熱的音/視頻 ID。支援設定一個或多個,多個 ID 之前使用半形逗號(,)分隔,最多支援 20 個。 音/視頻 ID 可通過以下方式擷取:
|
ca3a8f6e4957b658067095869****, a6e49sfgd23p5g9ja7095863**** |
| TaskType |
string |
是 |
提交的任務類型。取值:
|
Preload |
| Formats |
string |
否 |
設定需要重新整理或預熱的播放流格式。支援設定多個格式,多個格式之間使用半形逗號(,)分隔。若不設定,則預設重新整理或預熱所有格式的播放流。支援的格式如下:
|
mp4,m3u8 |
| Definitions |
string |
否 |
設定需要重新整理或預熱的播放流清晰度。支援設定多個清晰度,多個清晰度之間使用半形逗號(,)分隔。若不設定,則預設重新整理或預熱所有清晰度的播放流。 說明
取值必須為媒資參數說明中清晰度:Definition所定義的取值。 |
HD, SD |
| StreamType |
string |
否 |
設定需要重新整理或預熱的播放流類型。支援設定多個播放流類型,多個播放流類型之間使用半形逗號(,)分隔。若不設定,則預設重新整理或預熱所有的播放流類型。取值:
|
video |
| ResultType |
string |
否 |
設定重新整理或預熱的結果類型。取值:
|
Single |
| SliceFlag |
boolean |
否 |
設定是否重新整理或預熱 M3U8 播放流的 TS 檔案的播放連結。取值:
|
false |
| SliceCount |
integer |
否 |
設定重新整理或預熱 M3U8 播放流的 TS 檔案播放連結的個數。每個 M3U8 播放流僅會重新整理前 N 個 TS 檔案的播放連結。取值範圍為 1~20,預設值為 5。 |
5 |
| UserData |
string |
否 |
自訂設定。為 JSON 字串,支援訊息回調、上傳加速等設定。更多資訊,請參見 UserData 。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| MediaRefreshJobId |
string |
重新整理或預熱的任務 ID |
41d465e31957**** |
| NonExistMediaIds |
string |
不存在的音/視頻 ID 列表。 |
ca3a8f6e4957b658067095869**** |
| ForbiddenMediaIds |
string |
被禁止操作的音/視頻 ID 列表,通常是由於沒有多應用的許可權而導致被禁止操作,更多資訊,請參見多應用。 |
a6e49sfgd23p5g9ja7095863**** |
| RequestId |
string |
請求 ID。 |
25818875-5F78-4AF6-04D5-D7393642**** |
樣本
正常返回樣本
JSON格式
{
"MediaRefreshJobId": "41d465e31957****",
"NonExistMediaIds": "ca3a8f6e4957b658067095869****",
"ForbiddenMediaIds": "a6e49sfgd23p5g9ja7095863****",
"RequestId": "25818875-5F78-4AF6-04D5-D7393642****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。