InvalidateCache ポリシー

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

キャッシュから値を削除する方法を構成します。

このポリシーは、汎用の短期のキャッシュ保存での使用を目的としています。このポリシーは、PopulateCache ポリシー（エントリの書き込み）と LookupCache ポリシー（キャッシュ エントリの読み取り）と組み合わせて使用します。

バックエンド リソースのレスポンスのキャッシュ保存については、ResponseCache ポリシーをご覧ください。

このポリシーは拡張可能なポリシーです。Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

注: ポリシーを使わずにメッセージ フローの外部からキャッシュをクリアするには、Delete caches API を使用できます。

要素リファレンス

このポリシーで構成できる要素を次に示します。

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

<InvalidateCache> 属性

次の表に、すべてのポリシーの親要素に共通する属性を示します。

属性	説明	デフォルト	要否
name	ポリシーの内部名。name 属性の値には、英字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。この値は 255 文字を超えることはできません。 管理 UI プロキシ エディタで <DisplayName> 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。	なし	必須
continueOnError	ポリシーが失敗したときにエラーを返す場合は、false に設定します。これは、ほとんどのポリシーで想定される動作です。 ポリシーが失敗した後もフローの実行を続行する場合は、true に設定します。関連項目: 障害ルールはエラー状態の場合にのみトリガーされる（continueOnError について） 現在のフローにおける障害処理	false	省略可
enabled	ポリシーを適用するには、true に設定します。 ポリシーを無効にするには、false に設定します。ポリシーがフローに接続されている場合でも適用されません。	true	省略可
async	この属性は非推奨となりました。	false	非推奨

<DisplayName> 要素

管理 UI プロキシ エディタで name 属性と一緒に使用して、ポリシーのラベルに使用する自然言語名を指定します。

<DisplayName>Policy Display Name</DisplayName>

デフォルト	なし この要素を省略した場合、ポリシーの name 属性の値が使用されます。
要否	省略可
タイプ	文字列

<CacheContext>/<APIProxyName> 要素

キャッシュ エントリを追加したアプリケーションの名前を指定します。

<APIProxyName>application_that_added_the_entry</APIProxyName>

属性

属性	説明	デフォルト	要否	型
ref	アプリケーション名を格納する変数。	なし	省略可	文字列

<CacheContext> 要素

Prefix 要素の値が指定されていない場合にキャッシュキーを作成する方法、または別の API プロキシによって追加されたキャッシュ エントリを消去する方法を指定します。

<CacheContext>
  <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName>
  <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName>
  <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName>
</CacheContext>

CacheKey の作成に使用します。別の API プロキシが追加したキャッシュ エントリをクリアするときに CacheKey の接頭辞（カスタム接頭辞）を使用しない場合は、APIProxyName、ProxyName、TargetName の値は必須です。

<CacheKey> 要素

キャッシュに保存されているデータを参照する一意のポインタを構成します。

<CacheKey>
    <Prefix>string</Prefix>
    <KeyFragment ref="variable_name" />
    <KeyFragment>literal_string</KeyFragment>
</CacheKey>

デフォルト:	なし
要否:	必須
型:	なし

<CacheKey> はキャッシュに保存される各データの名前を構成します。

実行時に、<KeyFragment> の値には <Scope> 要素の値または <Prefix> の値が取り込まれます。たとえば、次の場合、キャッシュキーは UserToken__apiAccessToken__<value_of_client_id> になります。

<CacheKey>
    <Prefix>UserToken</Prefix>
    <KeyFragment>apiAccessToken</KeyFragment>
    <KeyFragment ref="request.queryparam.client_id" />
</CacheKey>

<CacheKey> 要素は、<Prefix> と <Scope> を組み合わせて使用します。詳細については、キャッシュキーの使用をご覧ください。

<CacheResource> 要素

メッセージを保存するキャッシュを指定します。

このポリシー（対応する PopulateCache ポリシーと LookupCache ポリシーを含む）が、あらかじめ用意された共有キャッシュを使用している場合は、この要素を完全に省略します。

<CacheResource>cache_to_use</CacheResource>

デフォルト:	なし
プレゼンス:	省略可
型:	文字列

キャッシュの構成の詳細については、汎用キャッシュをご覧ください。

<CacheKey>/<KeyFragment> 要素

キャッシュキーに含める値を指定します。ref 属性で参照解除する変数、または固定値を指定します。

<KeyFragment ref="variable_name"/>
<KeyFragment>literal_string</KeyFragment>

デフォルト:	なし
プレゼンス:	省略可
型:	なし

Apigee はランタイムに、<Scope> 要素または <Prefix> 要素から取得した値を先頭に付加して、各 <KeyFragment> 要素の解決された値を連結してキャッシュキーを作成します。詳細については、キャッシュキーの使用をご覧ください。

属性

属性	説明	デフォルト	要否	型
ref	値を取得する変数。この要素にリテラル値が含まれている場合は、使用できません。	なし	省略可	文字列

<CacheKey>/<Prefix> 要素

キャッシュキーの接頭辞として使用する値を指定します。

<Prefix>prefix_string</Prefix>

デフォルト:	なし
プレゼンス:	省略可
型:	文字列

<Prefix> 要素は <Scope> 要素をオーバーライドします。

Apigee はランタイムに、<Scope> 要素または <Prefix> 要素から取得した値を先頭に付加して、各 <KeyFragment> 要素の解決された値を連結してキャッシュキーを作成します。詳細については、キャッシュキーの使用をご覧ください。

<CacheContext>/<ProxyName> 要素

データをキャッシュに保存したプロキシの名前を指定します。

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

デフォルト:	なし
プレゼンス:	省略可
型:	文字列

属性

属性	説明	デフォルト	要否	型
ref	値を取得する変数。この要素にリテラル値が含まれている場合は、使用できません。	なし	省略可	文字列

<PurgeChildEntries> 要素

true。これらのアイテムをキャッシュに読み込んだ PopulateCache ポリシー インスタンスがさまざまな <KeyFragment> 要素を使用した場合でも、このポリシー用に構成された同じ <Prefix> 値を共有するキャッシュ エントリを削除します。

同じ接頭辞値のすべてのキャッシュ エントリを無効にすると、複数の関連エントリを同時に削除できます。

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

デフォルト:	false
要否:	省略可
型:	ブール値

<Scope> 要素

<Prefix> 要素が <CacheKey> 要素で指定されていない場合に、キャッシュキーの接頭辞を作成するために使用される列挙値です。

<Scope>scope_enumeration</Scope>

デフォルト:	Exclusive
要否:	省略可
型:	文字列

<Scope> の設定は、<Scope> の値に応じて接頭辞が付加されるキャッシュキーを決定します。たとえば、スコープが Exclusive に設定されている場合、キャッシュキーは次の形式になります。

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

<Prefix> 要素が <CacheKey> に含まれている場合、この要素の値が <Scope> 要素の値を置き換えます。<Scope> 要素の有効な値を以下に示します。

詳細については、キャッシュキーの使用をご覧ください。

使用できる値

スコープ値	説明
Global	キャッシュキーが、環境にデプロイされているすべての API プロキシで共有されます。キャッシュキーは、orgName __ envName __ の形式で値の先頭に付加されます。 <KeyFragment> apiAccessToken と <Global> スコープを設定した <CacheKey> エントリを定義すると、各エントリは、シリアル化されたアクセス トークン値が後に続く orgName__envName__apiAccessToken として保存されます。たとえば、「apifactory」という組織の「test」という環境にデプロイされた API プロキシの場合、アクセス トークンはキャッシュキー apifactory__test__apiAccessToken で保存されます。
Application	API プロキシ名が接頭辞として使用されます。 キャッシュキーは orgName__envName__applicationName という形式で値の先頭に付加されます。
Proxy	ProxyEndpoint 構成が接頭辞として使用されます。 キャッシュキーは、orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName という形式で値の先頭に付加されます。
Target	TargetEndpoint 構成が接頭辞として使用されます。 キャッシュキーは orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName という形式で値の先頭に付加されます。
Exclusive	デフォルト。これが最も特定的なスコープであるため、任意のキャッシュ内で名前空間が競合するリスクが最小限になります。 接頭辞は次のいずれかの形式をとります。 ポリシーが ProxyEndpoint フローに接続されている場合、接頭辞は ApiProxyName_ProxyEndpointName の形式になります。 ポリシーが TargetEndpoint に接続されている場合、接頭辞は ApiProxyName_TargetName の形式になります。 キャッシュキーは、orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName という形式で値の先頭に付加されます。 たとえば、完全な文字列は次のようになります。 apifactory__test__weatherapi__16__default__apiAccessToken

<CacheContext>/<TargetName> 要素

データをキャッシュに保存したターゲット エンドポイントの名前を指定します。

<TargetName>endpoint_for_which_data_was_cached</TargetName>

デフォルト:	なし
プレゼンス:	省略可
型:	文字列

属性

属性	説明	デフォルト	要否	型
ref	値を取得する変数。この要素にリテラル値が含まれている場合は、使用できません。	なし	省略可	文字列

使用上の注意

Populate Cache ポリシー、LookupCache ポリシー、InvalidateCache ポリシーが使用する汎用キャッシュは、ユーザーが構成するキャッシュか、デフォルトで含まれる共有キャッシュのどちらかです。ほとんどの場合、基盤となる共有キャッシュで十分です。このキャッシュを使用する場合は、<CacheResource> 要素を省略します。

キャッシュの構成方法については、汎用キャッシュをご覧ください。基盤となるデータストアについて詳しくは、キャッシュの内部をご覧ください。

エラーコード

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults.

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Tip: Need help resolving an error? Click in the Fix column for detailed troubleshooting information.

Error name	Cause	Fix
InvalidCacheResourceReference	This error occurs if the <CacheResource> element in the InvalidateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
CacheNotFound	This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component.

Fault variables

N/A

Example error response

N/A