調(diào)用本接口將源站的內(nèi)容主動預(yù)熱到L2 Cache節(jié)點上,首次訪問可直接命中緩存,緩解源站壓力。
接口說明
說明
目前服務(wù)地址僅支持:華東 2(上海)。
同一賬號每天最多可提交預(yù)熱 URL 請求共 500 條,目前不支持目錄級別的預(yù)熱。
刷新預(yù)熱類接口包含 RefreshVodObjectCaches 刷新接口和 PreloadVodObjectCaches 預(yù)熱接口。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vod:PreloadVodObjectCaches | update | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ObjectPath | string | 是 | 預(yù)熱文件 URL。多個 URL 使用換行符(\n 或\r\n)分隔。 | vod.test.com/test.txt |
Area | string | 否 | 預(yù)熱區(qū)域,取值:domestic, overseas。 | domestic |
L2Preload | boolean | 否 | 是否直接預(yù)熱到 L2 節(jié)點。取值:
| true |
WithHeader | string | 否 | 預(yù)熱請求默認(rèn)攜帶的 header 是 Accept-Encoding:gzip,如果您需要預(yù)熱請求攜帶其他 header,或者實現(xiàn)多副本預(yù)熱,那么可以使用該參數(shù)來實現(xiàn)自定義預(yù)熱 header。用 JSON 串格式提交。 | { "Accept-Encoding": [ "gzip, deflate, br" ] } |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PreloadTaskId": "9524****",
"RequestId": "E5BD4B50-7A02-493A-*****-97B9024B4135"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-07-03 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
接口錯誤碼
下表列舉了本接口特有的錯誤碼。
錯誤代碼 | 錯誤信息 | HTTP 狀態(tài)碼 | 說明 |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | 請求被流量控制限制。 |
IllegalOperation | Illegal domain operate is not permitted. | 403 | 非法域名, 無法操作。 |
OperationDenied | Your account does not open VOD service yet. | 403 | 賬號未開通視頻點播服務(wù)。 |
OperationDenied.Suspended | Your VOD service is suspended. | 403 | 賬號已欠費,請充值。如果您欠費超過 15 天,續(xù)費后需要重新開通點播服務(wù)。 |
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不屬于當(dāng)前用戶。 |
InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下線。 |
QuotaExceeded.Refresh | You’ve exceeded the prescribed refresh limits. | 400 | 超出當(dāng)日刷新限制。 |
PreloadQueueFull | Preload queue is full, please try again later! | 403 | 預(yù)熱隊列已滿(域名正在預(yù)熱的 URL 個數(shù)已經(jīng)達(dá)到上限),請稍后再試。 |
InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失敗, 無法刷新。 |
MissingParameter | The input parameter “ObjectPath” that is mandatory for processing this request is not supplied. | 400 | 缺少 ObjectPath 參數(shù)。 |
InvalidObjectPath.Malformed | The specific value of parameter ObjectPath is malformed. | 400 | ObjectPath 值格式錯誤。 |
InvalidExtensiveDomain.ValueNotSupported | Extensive domain not supported. | 400 | 不支持泛域名。 |
InvalidObjectPath.Size.Malformed | The size of ObjectPath is bigger than 1000. | 400 | 預(yù)熱 URL 個數(shù)一次不能超過 1000。 |