RefreshObjectCaches

更新時間:
Copy as MD

重新整理節點上的檔案內容。被重新整理的檔案快取將立即失效,新的請求將回源獲取最新的檔案,支援 URL 批量重新整理。

介面說明

注意事項

  • 提交重新整理任務並成功執行後,CDN 節點上對應的快取資源將會失效,當您再次發起存取請求時,節點會回源站拉取所需資源,並重新快取在節點上,因此大批量提交重新整理任務會清空較多快取,導致回源頻寬和請求突增,增加源站壓力。

  • 重新整理任務從提交到生效,大約需要 5~6 分鐘,如果檔案或者目錄設定的快取過期時間少於 5 分鐘,您無需執行重新整理操作,等待檔案或者目錄快取逾時更新即可。

  • 使用 RAM 使用者來執行重新整理或預熱操作的,需要先獲得授權,請參見授予 RAM 使用者重新整理預熱權限完成授權。

URL 重新整理配額

  • 預設情況下,一個帳號每日最多可以提交 10000 條 URL 重新整理和 100 個目錄重新整理,目錄重新整理包含子目錄。如果您的阿里雲帳號的日頻寬峰值大於 200 Mbps,您可以參考提交工單申請提升每日配額,阿里雲將根據您業務的實際需求進行評估和設定。

  • 預設情況下,一個帳號每日最多可以提交 20 個正則重新整理、100 個去參數重新整理,如果您的阿里雲帳號的日頻寬峰值大於 10 Gbps,您可以透過提交工單來申請提升每日配額。

  • 每次請求最多支援提交 1000 條 URL 重新整理或者 100 個目錄重新整理或者 1 個正則重新整理。

  • 單個網域名稱每分鐘最多支援提交 10000 條 URL 重新整理。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cdn:RefreshObjectCaches

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

請求參數

名稱

類型

必填

描述

樣本值

ObjectPath

string

  • 單次提交多個 URL 或多個目錄時,使用換行符分隔。

  • 單次提交的任務中所有 URL 的網域名稱個數總和需要在 10 個以內。

http://example.com/image/1.png http://aliyundoc.com/image/2.png

ObjectType

string

重新整理類型。取值範圍:

  • File(預設值):URL。

  • Directory:目錄。

  • Regex:正則重新整理。

  • IgnoreParams:去參數重新整理。去參數指的是去除請求 URL 中??之後的參數,去參數重新整理指的是使用者先透過介面提交去參數後的 URL,然後使用者提交的待重新整理 URL 將會與已快取資源的 URL 進行去參數比對,如果已快取資源的 URL 去參數以後與待重新整理 URL 比對,那麼 CDN 節點將對快取資源執行重新整理處理。

說明
  • URL 重新整理和目錄重新整理的功能說明請參考重新整理和預熱資源

  • 檔案重新整理將直接刪除節點上的資源,當有新請求時回源拉取新資源。其它重新整理類型預設只重新整理發生變更的資源,需要強制重新整理請設定 Force 參數為 true,詳見 Force 參數說明。

File

Force

boolean

是否直接刪除 CDN 節點上的快取。預設為 false。

  • true:直接刪除 CDN 節點上的快取。直接刪除意味著立即將指定的快取資源從 CDN 的所有節點上刪除,下一個對該資源的請求將需要存取來源伺服器去獲取最新版本的資料,然後重新進行快取。這種方式可以確保一旦執行了刪除操作後,所有後續請求都將獲得最新的內容,適合於需要立即更新快取內容的情況,例如緊急修復安全漏洞或者發佈重要更新時。但需要注意的是,這可能會瞬間增加來源伺服器的壓力,因為所有相關請求都需要存取來源伺服器。

  • false:對 CDN 節點上的快取標記過期。將快取資源標記為過期之後,下一個對該資源的請求到達時,CDN 節點將會回源驗證該資源的最新版本,若與當前快取資源一致,則直接傳回已快取資源,若不一致,則回源拉取新資源傳回給使用者,並重新快取該資源。這種方法的好處是它允許逐漸更新快取中的內容,而不是立即全部清除,適用於需要平滑過渡的情況,可以減少由於直接刪除大量快取而可能導致源站壓力增大。

說明

此參數生效範圍:使用目錄重新整理、正則重新整理、去參數重新整理這三種重新整理方式的時候可以生效。

false

ReplicaTag

string

參數暫不可用。

false

返回參數

名稱

類型

描述

樣本值

object

RefreshTaskId

string

重新整理傳回的任務 ID,多個任務 ID 用半形逗號(,)分隔。重新整理傳回的任務 ID 會按照以下兩條規則對重新整理任務做合併:

  • 同一個網域名稱、同一秒鐘提交的重新整理任務(URL 顆粒度)會被合併為同一個 RefreshTaskId。

  • 同一個網域名稱、同一秒鐘提交的重新整理任務(URL 顆粒度)如果超過 2000 條,那麼會按照每 2000 條合併為一個 RefreshTaskId 的方式處理。

704222901

RequestId

string

請求 ID。

D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C

樣本

正常返回樣本

JSON格式

{
  "RefreshTaskId": "704222901",
  "RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 SingleRequest.OverLimit A maximum of 1000 URLs are supported for each request.
400 InvalidObjectType.Malformed The specified ObjectType is invalid.
400 InvalidObjectPath.Malformed The specified ObjectPath is invalid.
400 QuotaExceeded.Refresh Your refresh attempts have exceeded the daily limit.
400 InvalidExtensiveDomain.ValueNotSupported The specified ExtensiveDomain is not supported.
400 QuotaPerMinuteExceeded.Refresh You tried to refresh too frequently, please try again later.
400 TooMany.Refresh The refresh queue is full, please try again later.
429 TooManyRequests Too many requests, please try again later

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

變更歷史

更多資訊,參考變更詳情