Översikt över cachelagring

GÄLLER FÖR: Alla API Management-nivåer

Konfigurera cachelagring i Azure API Management för att lagra och hämta svar på API-begäranden och relaterad information. Genom att lagra svar från serverdelstjänster kan API Management hantera efterföljande identiska begäranden direkt från cachen, vilket minskar behovet av att anropa serverdelstjänsten upprepade gånger. Cachelagring kan förbättra API-prestanda, minska belastningen på serverdelen och förbättra den övergripande upplevelsen för kunder som anropar API:er via API Management.

Den här artikeln beskriver alternativen för cachelagring i API Management och belyser viktiga scenarier och konfigurationsöverväganden.

Alternativ för cachelagringstjänst

Azure API Management tillhandahåller följande alternativ för cachelagringstjänsten för att uppfylla olika prestanda- och arkitekturkrav.

• Intern (inbyggd): Den interna (inbyggda) cachen etableras automatiskt på alla API Management-tjänstnivåer (förutom förbrukningsnivån ). Den interna cacheimplementeringen skiljer sig mellan de klassiska nivåerna (Developer, Basic, Standard och Premium) och v2-nivåerna (Basic v2, Standard v2 och Premium v2). Den inbyggda cachen på v2-nivåerna ger bättre tillförlitlighet. Läs mer om cachelagring med den inbyggda cachen.

• Extern cache: Om du vill ha bättre prestanda och beständighet kan du välja att konfigurera en extern Redis-kompatibel cache, till exempel Azure Managed Redis, för användning med valfri API Management-tjänstnivå eller gateway. Läs mer om hur du konfigurerar en extern cache med Azure Managed Redis.

I följande tabell jämförs funktionerna i det interna och externa cacheminnet.

Cachelagringsscenarier

Använd cachelagring i Azure API Management för scenarier som de i följande tabell.

Considerations:

• I alla cachelagringsscenarion bör du överväga möjligheten att cachetillgänglighet eller anslutning går förlorad. API Management använder ett "bästa möjliga" tillvägagångssätt för cachetillgänglighet. Om en konfigurerad cache inte är tillgänglig sker cachemissar och som standard fortsätter begäranden till serverdelstjänsten.

• På den klassiska API Management-nivån är den interna cachen instabil och bevaras inte mellan tjänstuppdateringar. Under en tjänstuppdatering rensas den interna cachen i en gradvis process som omfattar upp till 50% cacheminnet åt gången.

  Anmärkning

  Du kan konfigurera tjänstuppdateringsinställningar, inklusive en underhållsperiod för uppdateringar, för att minimera potentiell kundpåverkan, till exempel förlust av den interna cachen.

• Om du konfigurerar en extern cache kan den vara beständig, men du ansvarar för att säkerställa tillgänglighet och anslutning.

• Om du vill skydda serverdelstjänsten från trafiktoppar som kan överbelasta den när en cache inte är tillgänglig, konfigurerar du en hastighetsbegränsningsprincip (hastighetsbegränsning eller hastighetsgräns per nyckel) omedelbart efter någon cacheuppslagningsprincip.

Cachelagringsprinciper

Konfigurera cachelagringsprinciper för att styra hur API-svar cachelagras och hämtas i Azure API Management.

• Som standard i cachelagringsprinciper använder API Management en extern cache om den konfigureras och faller tillbaka till den inbyggda cachen annars.

• API Management tillhandahåller cachelagringsprinciper i par, enligt följande tabell. I en principdefinition konfigurerar du en cacheuppslagningsprincip i inbound avsnittet för att söka efter cachelagrade svar och en cachelagringsprincip i outbound avsnittet för att lagra lyckade svar i cacheminnet.

Exempel på cachelagringsprincip

Följande är grundläggande exempel på cachelagringsprinciper i API Management. Fler exempel finns i referensartiklarna för cachelagringsprincip .

Cachelagring av svar

Cachelagra fullständigt API-svar i intern cache för att betjäna identiska förfrågningar utan serverdelsanrop. I det här exemplet lagrar cachen svar i sju dagar.

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

Cachelagring av värde

Cachelagrar specifika datavärden för återanvändning mellan flera begäranden.

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

Hastighetsbegränsningsskydd

Som en bästa praxis, kombinera cacheuppslagning med hastighetsbegränsningar för att skydda bakgrundstjänster.

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

Säkerhetsfrågor

• Känsliga data: Undvik cachelagring av svar som innehåller känslig eller personlig information
• Cachenycklar: Se till att cachenycklar inte exponerar känslig information i loggar eller diagnostik
• Åtkomstkontroll: Extern cache kräver korrekt nätverkssäkerhet och åtkomstkontroller
• Kryptering: Använd TLS/SSL för anslutningar till externa cacheinstanser

Relaterat innehåll

• Läs mer om cacheprinciper i API Management
• Konfigurera extern cachelagring med Azure Managed Redis
• Exempel på anpassad cachelagring med avancerade scenarier
• Övervaka API Management-prestanda och cachelagringsmått