LookupCache ポリシー

このページの内容は Apigee と Apigee ハイブリッドに該当します。

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

ポリシー アイコン

キャッシュに保存された値を実行時に取り出す方法を構成します。

このポリシーは、汎用の短期のキャッシュ保存での使用を目的としています。Populate Cache ポリシー（エントリの書き込み）や Invalidate Cache ポリシー（エントリの無効化）と併せて使用します。

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

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

要素リファレンス

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

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

共有キャッシュはデフォルトで含まれています。共有キャッシュを使用するには、このポリシー構成で <CacheResource> 要素を省略します。

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

<LookupCache> 属性

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

属性 説明 デフォルト 要否
name

ポリシーの内部名。name 属性の値には、英字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。この値は 255 文字を超えることはできません。

管理 UI プロキシ エディタで <DisplayName> 要素を追加して、ポリシーのラベルに使用する別の自然言語名を指定することもできます。

 なし 必須
continueOnError

ポリシーが失敗したときにエラーを返す場合は、false に設定します。これは、ほとんどのポリシーで想定される動作です。

ポリシーが失敗した後もフローの実行を続行する場合は、true に設定します。関連項目:

 false 省略可
enabled

ポリシーを適用するには、true に設定します。

ポリシーを無効にするには、false に設定します。ポリシーがフローに接続されている場合でも適用されません。

 true 省略可
async

この属性は非推奨となりました。

 false 非推奨

<DisplayName> 要素

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

<DisplayName>Policy Display Name</DisplayName>
デフォルト

なし

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

<AssignTo> 要素

キャッシュからキャッシュ エントリを取り出した後、それが割り当てられる変数を指定します。変数は書き込み可能でなければなりません。キャッシュ ルックアップで値が得られない場合、変数は設定されません。

<AssignTo>variable_to_receive_cached_value</AssignTo>

デフォルト:

なし

要否:

 必須

型:

文字列

<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> を組み合わせて使用します。詳細については、キャッシュキーの使用をご覧ください。

<CacheLookupTimeoutInSeconds> 要素

キャッシュ ルックアップが失敗してから、キャッシュミスとみなすまでの秒数を指定します。キャッシュミスとみなされると、キャッシュミス パスに沿ってフローが再開されます。

<CacheLookupTimeoutInSeconds>12</CacheLookupTimeoutInSeconds>

デフォルト:

12

要否:

 省略可

型:

整数

<CacheResource> 要素

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

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

<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> 要素の解決された値を連結してキャッシュキーを作成します。詳細については、キャッシュキーの使用をご覧ください。

<Scope> 要素

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

<Scope>scope_enumeration</Scope>

デフォルト:

Exclusive

要否:

 省略可

型:

文字列

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

<Prefix> 要素が <CacheKey> に含まれている場合、この要素の値が <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

使用上の注意

このポリシーは汎用キャッシュに使用します。実行時には、LookupCache ポリシーがキャッシュから値を取り出し、AssignTo 要素で指定した変数に代入します（値が取り出せない場合、変数は設定されません）。CacheKey 要素と Scope 要素をつないで形成されるキャッシュキーに基づいて、値を探します。つまり、PopulateCache ポリシーによってキャッシュに追加された特定の値を取り出すには、LookupCache ポリシーのキャッシュキー関連の要素が PopulateCache ポリシーと同じ形で構成されている必要があります。

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

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

フロー変数

フロー変数を使用すると、HTTP ヘッダー コンテンツ、メッセージ コンテンツ、またはフローのコンテキストに基づいて、ポリシーとフローが実行時に動的に動作するよう構成できます。フロー変数の詳細については、フロー変数リファレンスをご覧ください。

LookupCache ポリシーで定義したキャッシュの動作をカスタマイズすると、次の事前定義されたフロー変数が使用可能になります。

変数 型 権限 説明
lookupcache.{policy-name}.cachename 文字列 読み取り専用 ポリシーで使用されているキャッシュ名を返します。
lookupcache.{policy-name}.cachekey 文字列 読み取り専用 使用されたキーを返します。
lookupcache.{policy-name}.cachehit ブール値 読み取り専用 指定されたキャッシュキーの値をポリシーが検出した場合は true。
lookupcache.{policy-name}.assignto 文字列 読み取り専用 キャッシュが割り当てられている変数を返します。

エラーコード

このセクションでは、このポリシーによってエラーがトリガーされたときに設定されるエラー メッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

エラーコードの接頭辞

なし

ランタイム エラー

このポリシーはランタイム エラーをスローしません。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

エラー名 原因 修正
InvalidCacheResourceReference このエラーは、API プロキシがデプロイされている環境に存在しない名前が <CacheResource> 要素に設定されている場合に発生します。
InvalidTimeout <CacheLookupTimeoutInSeconds> 要素が負の数に設定されている場合、API プロキシのデプロイは失敗します。
CacheNotFound このエラーは、エラー メッセージに記述されているキャッシュが、特定の Message Processor コンポーネント上に作成されていない場合に発生します。

障害変数

なし

エラー レスポンスの例

なし