PreloadDcdnObjectCaches - 預熱URL - Edge Security Acceleration

介面說明

相關介面：重新整理預熱類介面包含 RefreshDcdnObjectCaches 重新整理介面和 PreloadDcdnObjectCaches 預熱介面。
請求方式：支援 POST 請求，參數用 form 表單顯示。
URL 預熱配額（每日）：預設情況下，一個帳號每日最多可以提交 1000 條 URL 預熱任務，如果您帳號的日頻寬峰值大於 200 Mbps，可通過提交工單申請提升每日配額，阿里雲將根據您業務的實際需求進行評估和配置。
每次最多可以提交 100 條 URL 預熱任務。
預熱隊列規則：每個帳號的預熱隊列最大為 100,000 條 URL，DCDN 根據 URL 提交的先後順序進行預熱，當預熱隊列中未完成的任務達到了 100,000 條 URL 時，阿里雲 DCDN 將會採取排隊機制（即完成排序最前的一條 URL 預熱後才可以繼續提交下一條 URL 預熱）完成預熱。
單使用者調用頻率：15 次/秒。

注意事項

提交預熱任務並成功執行後，DCDN 節點會立即回來源站點載入所需資源，因此大批量提交預熱任務會產生較多的並發下載任務，導致回源頻寬和請求突增，增加來源站點壓力。
預熱任務從提交到預熱完成，實際執行時間視預熱檔案大小而定，大約需要 5~30 分鐘，檔案平均大小越小，預熱速度越快。
使用 RAM 使用者來執行重新整理或預熱操作的，需要先獲得授權，請參見授予 RAM 使用者重新整理預熱許可權完成授權。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dcdn:PreloadDcdnObjectCaches

none

*domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

無

請求參數

名稱	類型	必填	描述	樣本值
ObjectPath	string	是	預熱 URL，格式為加速網域名稱/預熱的檔案。說明多個 URL 之間用分行符號（\n）或（\r\n）分隔，ObjectPath 的單條長度最長為 1024 個字元。	example.com/examplefile.txt
Area	string	否	預熱地區，取值： domestic：僅中國內地。 overseas：全球（不包含中國內地）。如果不傳該參數，預設的預熱地區為您的網域名稱所配置的 DCDN 加速地區。具體如下：網域名稱的加速地區為“僅中國內地”，預熱地區是僅中國內地。網域名稱的加速地區為“全球”，預熱地區是全球。網域名稱的加速地區為“全球（不包含中國內地）”，預熱地區是全球（不包含中國內地）。	domestic
L2Preload	boolean	否	是否直接預熱到 L2 節點。取值： true：代表預熱的節點層級必須包含 L2 節點。 false：代表僅預熱回源層節點（false 為預設值，回源層節點可能是 L2 節點，也可能是 L3 節點）。	true
WithHeader	string	否	支援使用者自訂預熱 Header，用 JSON 串格式提交。	{ "Accept-Encoding": [ "gzip" ] }
QueryHashkey	boolean	否	配置了某些規則（如 URL 重寫、參數過濾等）開啟使用。該參數用於控制執行預熱任務時是否開啟 hashkey 查詢模式。取值範圍： false：預設模式，不傳參數的時候使用該模式，指的是直接使用提交的 URL 作為預熱檔案的 hashkey。 true：根據網域名稱的配置來查詢預熱 URL 實際使用的 hashkey。	true

返回參數

名稱	類型	描述	樣本值
	object
PreloadTaskId	string	預熱返回的任務 ID，多個任務 ID 用半形逗號（,）分隔。預熱返回的任務 ID 會按照以下兩條規則對預熱任務做合并：同一個網域名稱、同一秒鐘提交的預熱任務（URL 顆粒度）會被合并為同一個 RushTaskId。同一個網域名稱、同一秒鐘提交的預熱任務（URL 顆粒度）如果超過 500 條，那麼會按照每 500 條合并為一個 RushTaskId 的方式處理。	95248880
RequestId	string	請求 ID。	E5BD4B50-7A02-493A-AE0B-97B9024B4135

樣本

正常返回樣本

JSON格式

{
  "PreloadTaskId": "95248880",
  "RequestId": "E5BD4B50-7A02-493A-AE0B-97B9024B4135"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	SingleRequest.OverLimit	A maximum of 1000 URLs are supported for each request.
400	QuotaExceeded.Preload	Your refresh attempts have exceeded the daily limit.	超出當日重新整理預熱限制。
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.	ObjectPath錯誤，請填寫正確的ObjectPath。
400	InvalidExtensiveDomain.ValueNotSupported	The specified ExtensiveDomain is not supported.	不支援泛網域名稱。
400	PreloadQueueFull	The warming queue is full; please try again later.	網域名稱正在預熱的URL個數已經達到上限，請稍後重試。
400	InvalidObjectPath.ExceedsMaximum	The maximum number of urls is exceeded.	提交URL數超過最大限制。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。