LookupCache ポリシー

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

このポリシーは、汎用目的で短期間保存されるキャッシュに使用されるためのものです。Populate Cache ポリシー(エントリの書き込み)や Invalidate Cache ポリシー(エントリの無効化)と併せて使用します。

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

要素リファレンス

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

    <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> 要素

name 属性に加えて、管理 UI プロキシ エディタのポリシーに別のわかりやすい名前でラベルを付けるために使います。

<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>30</CacheLookupTimeoutInSeconds>
    

デフォルト:

30

要否:

省略可

型:

整数

<CacheResource> 要素

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

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

    <CacheResource>cache_to_use</CacheResource>
    

デフォルト:

なし

必須?:

省略可

型:

文字列

キャッシュの構成方法については、環境キャッシュの作成と編集をご覧ください。

<CacheKey> / <KeyFragment> 要素

キャッシュキーに含める値を指定する要素です。この値を使用して、リクエストをキャッシュに保存されたレスポンスと照合するための名前空間が作成されます。

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

デフォルト:

なし

必須?:

省略可

型:

なし

この要素には、キー(ユーザーが指定する静的な名前)または値(変数を参照して動的に設定されるエントリ)を指定できます。指定されたすべてのフラグメント(および接頭辞)が連結されてキャッシュキーが作成されます。

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

<KeyFragment> 要素は、<Prefix> および <Scope> とあわせて使用します。詳しくは、キャッシュキーの使用をご覧ください。

属性

属性 デフォルト 必須 説明
ref 文字列 ×

値の取得元とする変数。この要素にリテラル値が含まれている場合は、使用できません。

<CacheKey>/<Prefix> 要素

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

    <Prefix>prefix_string</Prefix>
    

デフォルト:

なし

必須?:

省略可

型:

文字列

<Scope> 列挙値ではなく独自の値を指定するには、<Scope> の代わりにこの要素の値を使用します。この要素が定義されている場合、<Prefix> によって、キャッシュに書き込まれたエントリの先頭にキャッシュキー値が付加されます。<Prefix> 要素の値は <Scope> 要素の値をオーバーライドします。

<Prefix> 要素は、<CacheKey> および <Scope> とあわせて使用します。詳しくは、キャッシュキーの使用をご覧ください。

<Scope> 要素

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

    <Scope>scope_enumeration</Scope>
    

デフォルト:

「Exclusive」

要否:

省略可

型:

文字列

<Scope> の値に応じて付加されるキャッシュキーは、<Scope> の設定によって決定されます。たとえば、scope が Exclusive に設定されている場合、キャッシュキーは次の形式になります。orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__[ serializedCacheKey ]

<Prefix> 要素が <CacheKey> に含まれている場合、この要素の値が <Scope> 要素の値に優先します。有効な値には、以下の列挙値が含まれます。

<Scope> 要素は、<CacheKey> および <Prefix> とあわせて使用します。詳しくは、キャッシュキーの使用をご覧ください。

有効な値

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 このエラーは、<CacheResource> 要素に設定された名前が API プロキシのデプロイ先に存在しない場合に発生します。 build
InvalidTimeout <CacheLookupTimeoutInSeconds> 要素に負の数が設定されていると、API プロキシのデプロイに失敗します。 build
CacheNotFound このエラーは、エラー メッセージにあるキャッシュが特定の Message Processor コンポーネントに作成されていない場合に発生します。 build

障害変数

なし

エラー レスポンスの例

なし