調(diào)用PushObjectCache將源站的內(nèi)容主動預(yù)熱到緩存節(jié)點(diǎn)上。您首次訪問可直接命中緩存,緩解源站壓力。
接口說明
- 請求方式:支持 POST 請求,參數(shù)用 form 表單顯示。
- 相關(guān)接口:刷新預(yù)熱類接口包含 RefreshObjectCaches 刷新接口和 PushObjectCache 預(yù)熱接口。
- URL 預(yù)熱配額(每日):默認(rèn)情況下,一個賬號每日最多可以提交 1000 條 URL 預(yù)熱任務(wù),如果您賬號的日帶寬峰值大于 200 Mbps,可通過配額管理申請?zhí)嵘咳张漕~,阿里云將根據(jù)您業(yè)務(wù)的實(shí)際需求進(jìn)行評估和配置。
- 每次最多可以提交 100 條 URL 預(yù)熱任務(wù)。
- 預(yù)熱隊列規(guī)則:每個賬號的預(yù)熱隊列最大為 100000 條 URL,CDN 根據(jù) URL 提交的先后順序進(jìn)行預(yù)熱;當(dāng)預(yù)熱隊列中待預(yù)熱的 URL 達(dá)到了 100000 條時,CDN 將會拒絕接收新的預(yù)熱任務(wù)。
- 單用戶調(diào)用頻率:50 次/秒。
- 如果您需要自動化刷新或預(yù)熱,請參見刷新預(yù)熱批處理腳本。
注意事項(xiàng)
- 提交預(yù)熱任務(wù)并成功執(zhí)行后,CDN 節(jié)點(diǎn)會立即回源站加載所需資源,因此大批量提交預(yù)熱任務(wù)會生成較多的并發(fā)下載任務(wù),導(dǎo)致回源帶寬和請求突增,增加源站壓力。
- 預(yù)熱任務(wù)從提交到預(yù)熱完成,實(shí)際執(zhí)行時間視預(yù)熱文件大小而定,大約需要 5~30 分鐘,文件平均大小越小,預(yù)熱速度越快。
- 使用 RAM 用戶來執(zhí)行刷新或預(yù)熱操作的,需要先獲得授權(quán),請參見授予 RAM 用戶刷新預(yù)熱權(quán)限完成授權(quán)。
- 預(yù)熱請求默認(rèn)攜帶的 header 是 Accept-Encoding:gzip,如果您需要預(yù)熱請求攜帶其他 header,或者實(shí)現(xiàn)多副本預(yù)熱,那么可以使用請求參數(shù) WithHeader 來實(shí)現(xiàn)自定義預(yù)熱 header。
- 預(yù)熱時,如果源站返回 307 等重定向相關(guān)的狀態(tài)碼,預(yù)熱任務(wù)并不會跟隨重定向地址繼續(xù)完成預(yù)熱,最終會導(dǎo)致預(yù)熱失敗。如果源站返回的是 301 或者 302 狀態(tài)碼,并且 CDN 上已經(jīng)開啟了回源 301/302 跟隨,這種情況下正常預(yù)熱不受影響。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎ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)操作 |
---|---|---|---|---|
cdn:PushObjectCache | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ObjectPath | string | 是 | 預(yù)熱 URL,格式為加速域名/預(yù)熱的文件。 說明
多個 URL 之間用換行符(\n)或(\r\n)分隔,ObjectPath 的單條長度最長為 1024 個字符。
| example.com/image/1.png\nexample.org/image/2.png |
Area | string | 否 | 預(yù)熱區(qū)域。取值:
如果不傳該參數(shù),默認(rèn)的預(yù)熱區(qū)域?yàn)槟挠蛎渲玫?CDN 加速區(qū)域。具體如下:
| domestic |
L2Preload | boolean | 否 | 是否直接預(yù)熱到 L2 節(jié)點(diǎn)。取值:
| true |
WithHeader | string | 否 | 預(yù)熱請求默認(rèn)攜帶的 header 是 Accept-Encoding:gzip,如果您需要預(yù)熱請求攜帶其他 header,或者實(shí)現(xiàn)多副本預(yù)熱,那么可以使用該參數(shù)來實(shí)現(xiàn)自定義預(yù)熱 header。用 JSON 串格式提交。 說明
若預(yù)熱的時候不需要 Accept-Encoding 頭部,則按如下提交
| { "Accept-Encoding": [ "gzip, deflate, br" ] } |
QueryHashkey | boolean | 否 | 該參數(shù)用于控制執(zhí)行預(yù)熱任務(wù)時是否開啟 hashkey 查詢模式。取值范圍:
| true |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PushTaskId": "9524xxxx",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | SingleRequest.OverLimit | A maximum of 1000 URLs are supported for each request. | - |
400 | QuotaExceeded.Preload | Your preload attempts have exceeded the daily limit. | 超出當(dāng)日預(yù)熱額度限制。 |
400 | InvalidObjectPath.Malformed | The specified ObjectPath is invalid. | - |
400 | InvalidExtensiveDomain.ValueNotSupported | The specified ExtensiveDomain is not supported. | - |
400 | PreloadQueueFull | The warming queue is full,please try again later. | - |
400 | PreloadQueueFull | Preload queue is full, please try again later. | 預(yù)熱隊列已滿,請稍候重試。 |
400 | QuotaPerMinuteExceeded.Refresh | You have exceeded the prescribed preload limits per minute. | - |
400 | InvalidObjectPath.ExceedsMaximum | The maximum number of urls is exceeded. | 提交URL數(shù)超過最大限制。 |
400 | InvalidCustomHeader | Parse preload header failed. | 自定義頭部解析錯誤。 |
400 | InvalidCustomHeader | Unsupported Preload headers included. | 無效的自定義預(yù)熱頭部。 |
429 | TooManyRequests | System load fluctuates, please try again later. | 系統(tǒng)負(fù)載波動,請稍候重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-11-03 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-08-21 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-07-25 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |