キャッシュの概要

適用対象: すべての API Management レベル

API 要求と関連情報に対する応答を格納および取得するように Azure API Management でキャッシュを構成します。 バックエンド サービスからの応答を格納することで、API Management は後続の同じ要求をキャッシュから直接処理できるため、バックエンド サービスを繰り返し呼び出す必要が減ります。 キャッシュにより、API のパフォーマンスが向上し、バックエンドの負荷が軽減され、API Management を使用して API を呼び出すお客様の全体的なエクスペリエンスが向上します。

この記事では、API Management のキャッシュ オプションについて説明し、主要なシナリオと構成に関する考慮事項について説明します。

キャッシュ サービスのオプション

Azure API Management には、さまざまなパフォーマンスとアーキテクチャの要件を満たすために、次のキャッシュ サービス オプションが用意されています。

• 内部 (組み込み): 内部 (組み込み) キャッシュは、( 従量課金 レベルを除く) すべての API Management サービス レベルで自動的にプロビジョニングされます。 内部キャッシュの実装は、クラシック レベル (Developer、 Basic、 Standard、 Premium) と v2 レベル (Basic v2、 Standard v2、 Premium v2) で異なります。 v2 レベルの組み込みキャッシュにより、信頼性が向上します。 組み込みキャッシュを使用したキャッシュの詳細について説明します。

• 外部 キャッシュ: パフォーマンスと永続化を強化するために、必要に応じて、任意の API Management サービス レベルまたはゲートウェイで使用するように、 Azure Managed Redis などの外部 Redis と互換性のあるキャッシュを構成します。 Azure Managed Redis を使用した外部キャッシュの設定の詳細について説明します。

次の表は、内部キャッシュと外部キャッシュの機能を比較しています。

キャッシュのシナリオ

次の表のようなシナリオでは、Azure API Management でキャッシュを使用します。

Considerations:

• キャッシュのシナリオでは、キャッシュの可用性または接続が失われる可能性を考慮してください。 API Management では、"ベスト エフォート" アプローチを使用して可用性をキャッシュします。 構成されたキャッシュを使用できない場合、キャッシュ ミスが発生し、既定ではバックエンド サービスへの要求が続行されます。

• API Management クラシック レベルでは、内部キャッシュは揮発性であり、サービスの更新間で保持されません。 サービスの更新中、内部キャッシュは、一度に最大 50% のキャッシュを含む段階的なプロセスでクリアされます。

  注

  サービス 更新プログラムの設定 (更新プログラムのメンテナンス期間など) を構成して、内部キャッシュの損失などの潜在的な顧客の影響を最小限に抑えることができます。

• 外部キャッシュを構成する場合は永続的である可能性がありますが、可用性と接続性を確保する責任があります。

• キャッシュが使用できないときに過負荷になる可能性があるトラフィックの急増からバックエンド サービスを保護するには、キャッシュ参照ポリシーの直後にレート制限ポリシー (レート制限 または キーごとのレート制限) を構成します。

キャッシュ ポリシー

キャッシュ ポリシーを構成して、Azure API Management で API 応答をキャッシュおよび取得する方法を制御します。

• キャッシュ ポリシーの既定では、API Management は構成されている場合は外部キャッシュを使用し、それ以外の場合は組み込みキャッシュにフォールバックします。

• API Management では、次の表に示すように、キャッシュ ポリシーがペアで提供されます。 ポリシー定義で、キャッシュされた応答を確認するために inbound セクションでキャッシュ参照ポリシーを構成し、成功した応答をキャッシュに格納するキャッシュ ストア ポリシーを outbound セクションに構成します。

キャッシュ ポリシーの例

API Management のキャッシュ ポリシーの基本的な例を次に示します。 その他の例については、 キャッシュ ポリシー のリファレンス記事を参照してください。

応答のキャッシュ

バックエンド呼び出しなしで同じ要求を処理するために、完全な API 応答を内部キャッシュにキャッシュします。 この例では、キャッシュは 7 日間応答を格納します。

<policies>
    <inbound>
        <base />
        <cache-lookup vary-by-developer="false" vary-by-developer-groups="false" downstream-caching-type="none" must-revalidate="true" caching-type="internal" >
            <vary-by-query-parameter>version</vary-by-query-parameter>
        </cache-lookup>
    </inbound>
    <outbound>
        <cache-store duration="604800" />
        <base />
    </outbound>
</policies>

値のキャッシュ

複数の要求間で再利用するために、特定のデータ値をキャッシュします。

<policies>
    <inbound>
        <cache-lookup-value key="user-preferences" default-value="none" variable-name="preferences" />
        <choose>
            <when condition="@(context.Variables["preferences"].ToString() == "none")">
                <!-- Load preferences from backend -->
                <send-request mode="new" response-variable-name="prefsResponse">
                    <set-url>https://backend.api/user/preferences</set-url>
                </send-request>
                <cache-store-value key="user-preferences" value="@(((IResponse)context.Variables["prefsResponse"]).Body.As<string>())" duration="1800" />
            </when>
        </choose>
    </inbound>
</policies>

レート制限保護

ベスト プラクティスとして、キャッシュ参照とレート制限を組み合わせてバックエンド サービスを保護します。

<policies>
    <inbound>
        <cache-lookup-value key="@("data-" + context.Request.IpAddress)" variable-name="cachedData" />
        <choose>
            <when condition="@(!context.Variables.ContainsKey("cachedData"))">
                <rate-limit calls="10" renewal-period="60" />
                <!-- Proceed to backend -->
            </when>
            <otherwise>
                <!-- Return cached data without rate limiting -->
                <return-response>
                    <set-body>@((string)context.Variables["cachedData"])</set-body>
                </return-response>
            </otherwise>
        </choose>
    </inbound>
</policies>

セキュリティに関する考慮事項

• 機密データ: 機密情報または個人情報を含む応答のキャッシュを回避する
• キャッシュ キー: キャッシュ キーがログや診断で機密情報を公開しないようにする
• アクセス制御: 外部キャッシュには、適切なネットワーク セキュリティとアクセス制御が必要です
• 暗号化: 外部キャッシュ インスタンスへの接続に TLS/SSL を使用する

関連コンテンツ

• API Management の キャッシュ ポリシーの 詳細
• Azure Managed Redis を使用して外部キャッシュを設定する
• 高度なシナリオでのカスタム キャッシュの例
• API Management の パフォーマンスとキャッシュ メトリックを監視する