RefreshObjectCaches API でコンテンツをキャッシュ消去 - CDN - Alibaba Cloud -

操作説明

リクエストメソッド: POST リクエストがサポートされています。パラメーターはフォームに表示されます。
関連操作: リフレッシュおよびプリフェッチ操作には、 RefreshObjectCaches リフレッシュ操作と PushObjectCache プリフェッチ操作が含まれます。
ユーザーあたりの最大呼び出し回数: 1 秒あたり 50 回。
リフレッシュまたはプリフェッチタスクを自動化するには、リフレッシュおよびプリフェッチ自動化スクリプトを参照してください。

始める前に

リフレッシュノードがコミットされ正常に実行されると、CDN ポイントオブプレゼンス上の対応するキャッシュリソースが無効になります。新しいアクセスリクエストを送信すると、ポイントオブプレゼンスは back-to-origin を実行して必要なリソースを取得し、再度キャッシュします。large な数のリフレッシュノードをコミットすると large な量のキャッシュがクリアされ、back-to-origin 帯域幅とリクエストが急増し、オリジンサーバーのロードが増加します。
リフレッシュノードはコミット後、効果が出るまで約 5〜6 分の時間がかかります。ファイルまたはフォルダに設定されたキャッシュ有効期限が 5 分未満の場合、リフレッシュ操作を実行する必要はありません。ファイルまたはフォルダのキャッシュがタイムアウトして自動的に更新されるのを待ってください。
Resource Access Management (RAM) ユーザーを使用してリフレッシュまたはプリフェッチ操作を実行するには、まず必要な権限付与を取得してください。RAM ユーザーにリフレッシュおよびプリフェッチ権限を付与するを参照して権限付与を完了してください。

URL リフレッシュクォータ

デフォルトでは、各アカウントは 1 日あたり最大 10,000 件の URL リフレッシュリクエストと 100 件のフォルダリフレッシュリクエストをコミットできます。フォルダリフレッシュにはサブディレクトリが含まれます。Alibaba Cloud アカウントの日次ピーク帯域幅が 200 Mbit/s を超える場合、チケットを送信を参照して、より高い日次割当クォータをリクエストできます。Alibaba Cloud は実際のビジネス要件に基づいてクォータを評価し設定します。
デフォルトでは、各アカウントは 1 日あたり最大 20 件の正規表現ベースのリフレッシュリクエストと 100 件のパラメータフィルタリングリフレッシュリクエストをコミットできます。Alibaba Cloud アカウントの日次ピーク帯域幅が 10 Gbit/s を超える場合、チケットを送信して、より高い日次割当クォータをリクエストできます。
各リクエストには、最大 1,000 件の URL リフレッシュエントリ、100 件のフォルダリフレッシュエントリ、または 1 件の正規表現ベースのリフレッシュエントリを含めることができます。
単一のドメイン名に対して、1 分あたり最大 10,000 件の URL リフレッシュエントリをコミットできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 から `?` およびその後のすべての文字を削除します。パラメータフィルタリングリフレッシュでは、API を通じてパラメーターを削除した URL をコミットします。コミットされた URL は、パラメーターが削除されたキャッシュリソース URL と照合されます。パラメータフィルタリング後にキャッシュリソース URL がコミットされた URL と一致する場合、CDN ポイントオブプレゼンスはキャッシュリソースに対してリフレッシュを実行します。説明 URL リフレッシュとフォルダリフレッシュの特徴説明については、リソースのリフレッシュとプリフェッチを参照してください。ファイルリフレッシュはポイントオブプレゼンスからリソースを直接削除します。新しいリクエストが到着すると、back-to-origin を通じて最新のリソースが取得されます。その他のリフレッシュタイプは、デフォルトでは変更されたリソースのみをリフレッシュします。強制リフレッシュを行うには、Force パラメーターを true にセットしてください。詳細については、Force パラメーターのメトリックの説明を参照してください。	File
Force	boolean	任意	CDN ポイントオブプレゼンス上のキャッシュを直接削除するかどうかを指定します。デフォルト値: false。 true: CDN ポイントオブプレゼンス上のキャッシュを直接削除します。これは、指定されたキャッシュリソースがすべての CDN ポイントオブプレゼンスから即座に削除されることを意味します。次のリソースリクエストはオリジンサーバーにアクセスして最新バージョンを取得し、再度キャッシュされます。これにより、削除後のすべての後続リクエストが最新のコンテンツを返すことが保証されます。このオプションは、緊急のセキュリティ脆弱性修正や重大な更新の公開など、即座のキャッシュ更新が必要なシナリオに適しています。すべての関連リクエストがオリジンサーバーにアクセスする必要があるため、オリジンサーバーのロードが一時的に増加する可能性があることに注意してください。 false: CDN ポイントオブプレゼンス上のキャッシュを期限切れとしてマークします。キャッシュリソースが期限切れとしてマークされた後、次のリソースリクエストにより CDN ポイントオブプレゼンスが back-to-origin を通じて最新バージョンを認証します。バージョンが現在の行キャッシュと一致する場合、キャッシュリソースが直接返されます。一致しない場合、back-to-origin を通じて最新のリソースが取得され、ユーザーに返され、再度キャッシュされます。このメソッドは、即座の完全消去ではなく、段階的なキャッシュ更新を可能にします。平滑化された移行が必要なシナリオに適しており、large な量のキャッシュを一度に削除することで生じるオリジンサーバーのロード増加を軽減します。説明このパラメーターは、フォルダリフレッシュ、正規表現ベースのリフレッシュ、またはパラメータフィルタリングリフレッシュを使用する場合にのみ効果があります。	false
ReplicaTag	string	任意	このパラメーターはアクティブではありません。	false

レスポンスフィールド

フィールド	型	説明	例
	object
RefreshTaskId	string	リフレッシュリクエストに対して返されるノード ID。複数のノード ID はコンマ (,) で区切られます。返されるノード ID は以下のルールに基づいてマージされます: 同一秒内に同じドメイン名に対してコミットされたリフレッシュノード (URL 粒度) は、単一の RefreshTaskId にマージされます。同一秒内に同じドメイン名に対して 2,000 件を超えるリフレッシュノード (URL 粒度) がコミットされた場合、2,000 件ごとのグループにマージされ、それぞれに個別の RefreshTaskId が割り当てられます。	704222901
RequestId	string	リクエスト ID。	D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。