調用本接口通過音視頻ID發起音視頻刷新或預熱任務。
接口說明
- 視頻點播提供資源的刷新和預熱功能，通過刷新功能，您可以刪除 CDN 節點上已經緩存的資源，并強制 CDN 節點回源站獲取最新資源；通過預熱功能，您可以在業務高峰前預熱熱門資源，提前將熱門資源下載并緩存到 CDN 節點，提高資源的訪問效率。
- 本接口直接通過音/視頻 ID 發起刷新或預熱任務，且支持篩選播放流格式及清晰度等，滿足用戶按需選擇合適的播放流進行刷新預熱的需求。
- 最多支持一次發起 20 個音/視頻的刷新或預熱任務。
QPS 限制
本接口的單用戶 QPS 限制為 50 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vod:RefreshMediaPlayUrls | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MediaIds | string | 是 | 需要刷新或預熱的音/視頻 ID。支持設置一個或多個，多個 ID 之前使用半角逗號（,）分隔，最多支持 20 個。 音/視頻 ID 可通過以下方式獲?。?/p>
| 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 | 否 | {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}} |
返回參數
示例
正常返回示例
JSON格式
{
"MediaRefreshJobId": "41d465e31957****",
"NonExistMediaIds": "ca3a8f6e4957b658067095869****",
"ForbiddenMediaIds": "a6e49sfgd23p5g9ja7095863****",
"RequestId": "25818875-5F78-4AF6-04D5-D7393642****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-03-31 | 新增 OpenAPI | 查看變更詳情 |