YanıtCache politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Bir arka uç kaynağından verileri önbelleğe alarak kaynağa yapılan istek sayısını azaltır. Uygulama olarak aynı URI'ye istekte bulunduğunda, bu politikayı önbelleğe alınan yanıtları döndürmek yerine bu istekleri arka uç sunucusuna iletir. ResponseCache politikası, API'nizin daha iyi performans sağlar.

ResponseCache'i muhtemelen API'niz tarafından kullanılan arka uç verileri güncellendiğinde daha faydalı bulursunuz yalnızca belirli aralıklarla alırsınız. Örneğin, hava durumu raporu verilerini gösteren bir API'niz olduğunu varsayalım. yalnızca on dakikada bir yenilenir. Şu tarihler arasında önbelleğe alınmış yanıtları döndürmek için ResponseCache'ı kullanarak arka uca ulaşan istek sayısını azaltabilirsiniz. Bu da ekip üyelerinin sayısı.

Genel amaçlı kısa vadeli önbelleğe alma için Önbelleği Doldurma politikasını kullanmayı düşünebilirsiniz. Bu politika, Arama Önbelleği politikasıyla (önbellek girişlerini okumak için) ve Önbellek politikasını geçersiz kılma (girişleri geçersiz kılmak için)

Örnekler

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

'http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778' -H "bypass-cache:true"

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <!-- Explicitly refresh the cached response -->
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

Öğe referansı

Öğe referansı, politikanın öğelerini ve özelliklerini açıklar.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" />
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSeconds ref="flow.variable.here">300</TimeoutInSeconds>
    </ExpirySettings>
    <CacheResource>cache_to_use</CacheResource>
    <CacheLookupTimeoutInSeconds/>
    <ExcludeErrorResponse/>
    <SkipCacheLookup/>
    <SkipCachePopulation/>
    <UseAcceptHeader/>
    <UseResponseCacheHeaders/>
</ResponseCache>

<ResponseCache> özellikler

<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<CacheKey> öğe

Önbellekte depolanan bir veri parçasına yönelik benzersiz bir işaretçi yapılandırır.

Önbellek anahtarları 2 KB boyutuyla sınırlıdır.

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

<CacheKey>, önbellekte depolanan her bir veri parçasının adını oluşturur. Anahtar, genellikle varlık başlıklarındaki veya sorgu parametrelerindeki bir değer kullanılarak ayarlanır. Böyle durumlarda öğenin ref özelliği, anahtar değerini içeren bir değişken belirtir.

Çalışma zamanında, <KeyFragment> değerlerinin başına <Scope> öğe değeri veya <Prefix> değeri. Örneğin, sonuç, şu önbellek anahtarıyla sonuçlanır: UserToken__apiAccessToken__<value_of_client_id>:

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

<CacheKey> öğesini şununla birlikte kullanırsınız: <Prefix> ve <Scope>. Daha fazla bilgi için Önbellek anahtarlarıyla çalışma başlıklı makaleyi inceleyin.

<CacheLookupTimeoutInSeconds> öğe

Başarısız bir önbellek aramasının kaç saniye sonra bir değer olarak kabul edileceğini (saniye cinsinden) önbellekte yok. Bu durumda akış önbellekte olmayan yol boyunca devam eder.

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

<CacheResource> öğe

Mesajların depolanacağı önbelleği belirtir. Dahil edilen paylaşılan önbellek. Aşağıdaki bilgileri kullanıyorsanız bir CacheResource öğesini önbellekte bulunan girişleri yönetimsel olarak temizleyin. Bu konuda daha fazla bilgi için Önbellekler başlıklı makaleyi inceleyin.

<CacheResource>cache_to_use</CacheResource>

Önbellekleri yapılandırma hakkında daha fazla bilgi edinmek için Ortam oluşturma ve düzenleme önbellek hakkında daha fazla bilgi edinin.

<CacheKey>/<KeyFragment> öğe

Eşleştirme için bir ad alanı oluşturarak önbellek anahtarına eklenmesi gereken bir değeri belirtir yapılan istek.

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

Bu bir anahtar (sağladığınız statik bir ad) veya bir değer ( bir değişkene referansta bulunması) gerekir. Belirtilen tüm parçalar birleştirilir (artı önek) önbellek anahtarını oluşturun.

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

<KeyFragment> öğesini şununla birlikte kullanırsınız: <Prefix> ve <Scope>. Daha fazla bilgi için Önbellek anahtarlarıyla çalışma başlıklı makaleyi inceleyin.

Özellikler

<CacheKey>/<Prefix> öğe

Önbellek anahtarı öneki olarak kullanılacak değeri belirtir.

<Prefix>prefix_string</Prefix>

Kendi değerinizi belirtmek istediğinizde <Scope> yerine bu değeri kullanın yerine <Scope> kullanabilirsiniz. Tanımlanmışsa <Prefix>, önbelleğe yazılan girişlerin başına önbellek anahtarı değerini ekler. CEVAP <Prefix> öğe değeri, <Scope> öğesini geçersiz kılar değer.

<Prefix> öğesini şununla birlikte kullanırsınız: <CacheKey> ve <Scope>. Daha fazla bilgi için Önbellek anahtarlarıyla çalışma başlıklı makaleyi inceleyin.

<ExcludeErrorResponse> öğe

Şu anda bu politika varsayılan olarak HTTP yanıtlarını herhangi bir mümkün Durum kodu. Bu, hem başarı hem de hata yanıtlarının önbelleğe alındığı anlamına gelir. Örneğin, hem 2xx hem de 3xx durum kodları varsayılan olarak önbelleğe alınır.

Hedefi önbelleğe almak istemiyorsanız bu öğeyi true olarak ayarlayın HTTP hata durum kodları içeren yanıtlar; yalnızca 200 ile 205 arasında durum kodlarına sahip yanıtlar bu öğe true ise önbelleğe alınır. Edge'in saydığı sadece HTTP durum kodları bunlardır "başarı" ve bu ilişkilendirmeyi değiştiremezsiniz.

Bu öğenin kullanışlı olduğu Yanıt Önbelleği kalıplarıyla ilgili açıklamalar için bu topluluk gönderisine göz atın.

Not: Gelecekteki bir sürümde (daha sonra belirlenecek), bu öğesi true olarak değişir. Apigee'ye göz atın Ayrıntılar için Sürüm Notları'na göz atın.

<ExcludeErrorResponse>true</ExcludeErrorResponse>

<ExpirySettings> öğe

Önbellek girişinin ne zaman sona ereceğini belirtir. Mevcut olduğunda <TimeoutInSeconds> hem <TimeOfDay> hem de <ExpiryDate> değerlerini geçersiz kılar.

<ExpirySettings>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
</ExpirySettings>

<ExpirySettings>/<ExpiryDate> öğe

Önbellek girişinin süresinin dolacağı tarihi belirtir. mm-dd-yyyy formunu kullanın. Mevcut olduğunda bu öğenin kardeş öğesi (<TimeoutInSeconds>) geçersiz kılmaları <ExpiryDate>.

<ExpirySettings>
    <ExpiryDate ref="{date_variable}">expiration_date</ExpiryDate>
</ExpirySettings>

Özellikler

<ExpiryDate ref="" />

<ExpirySettings>/<TimeOfDay> öğe

Önbellek girişinin gün içinde sona ereceği saat. hh:mm:ss formunu kullanın . Mevcut olduğunda bu öğenin kardeş öğesi (<TimeoutInSeconds>) geçersiz kılmaları <TimeOfDay>.

Saati SS:dd:ss biçiminde girin. Burada SS, 24 saatlik biçimin saatini temsil eder. Örneğin, Örneğin, öğleden sonra 2:30 için 14:30:00.

Günün saati için varsayılan yerel ayar ve saat dilimi, kodun bulunduğu yere bağlı olarak değişir. çalışıyor (politikayı yapılandırdığınızda bu bilgi bilinemez). yerel ayara erişmek için Bir ortam önbelleğinizdir.

<ExpirySettings>
    <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

Özellikler

<ExpirySettings>/<TimeoutInSec> öğe

Önbellek girişinin süresinin dolacağı saniye sayısı.

<ExpirySettings>/<TimeoutInSeconds> öğe

Önbellek girişinin süresinin dolacağı saniye sayısı. Bu öğe mevcut olduğunda <TimeOfDay> ve <ExpiryDate> kardeşlerini geçersiz kılar.

<ExpirySettings>
    <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
</ExpirySettings>

Not: Referansın duration_variable.

Özellikler

<Scope> öğe

<Prefix> anahtar kelimesi olduğunda önbellek anahtarı için bir önek oluşturmak üzere kullanılan numaralandırma öğesi, <CacheKey> öğesinde sağlanmamış.

<Scope>scope_enumeration</Scope>

<Scope> ayarı, <Scope> değeri. Örneğin, bir önbellek anahtarı aşağıdaki biçimi kullanarak kapsam Exclusive olarak ayarlanırsa : orgName__envName__apiProxyName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ] değerini kullanarak bulabilirsiniz.

<CacheKey> içinde bir <Prefix> öğesi varsa <Scope> öğe değerinin yerini alır. Geçerli değerler numaralandırmaları içerir bölümüne göz atın.

<Scope> öğesini şununla birlikte kullanırsınız: <CacheKey> ve <Prefix>. Daha fazla bilgi için Önbellek anahtarlarıyla çalışma başlıklı makaleyi inceleyin.

Kabul edilebilir değerler

apifactory__test__weatherapi__16__default__apiAccessToken

<SkipCacheLookup> öğe

Çalışma zamanında doğru olarak değerlendirilirse önbellek aramasını belirten bir ifade tanımlar atlanmalı ve önbellek yenilenmelidir. Ayrıca bkz. video'yu inceleyin.

<SkipCacheLookup>variable_condition_expression</SkipCacheLookup>

Aşağıdaki örnekte, atlama-önbelleği değişkeni gelen bir üstbilgide doğru değerine ayarlanırsa, önbellek araması atlanır ve önbellek yenilenir.

<SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>

<SkipCachePopulation> öğe

Çalışma zamanında doğru olarak değerlendirilirse önbellek atlanmalıdır. Ayrıca bkz. video'yu inceleyin.

<SkipCachePopulation>variable_condition_expression</SkipCachePopulation>

Örneğin, yanıt durum kodu 400 veya daha yüksek:

<SkipCachePopulation>response.status.code >= 400</SkipCachePopulation>

<UseAcceptHeader> öğe

Yanıt önbellek girişinin önbellek anahtarına şuradan değer eklenmesini sağlamak için true olarak ayarlayın: yanıtı Kabul edin.

Edge, Accept, Accept-Encoding, Accept-Language uygulamalarını kullanır ve Accept-Charset istek üstbilgilerini kullanabilirsiniz. Bu yaklaşım müşterinin istemediği bir medya türünü almasını engeller.

Örneğin, iki isteğin aynı URL'den gelip gelmediğini düşünün. Birinci isteğin gzip dosyasını kabul eder, ikincisi ise yapmaz. İlk istek önbelleğe alınacak ve önbelleğe alınan giriş, gzip biçiminde bir yanıt olacaktır. İkinci istek, önbelleğe alınan değeri okur ve daha sonra gzip dosyasını okuyamayan bir istemciye gzip biçiminde bir giriş döndürür.

Daha fazla bilgi için Önbellek anahtarı yapılandırma sayfasına bakın.

<UseAcceptHeader>false</UseAcceptHeader>

<UseResponseCacheHeaders> öğe

"Süre" ayarlanırken HTTP yanıt üstbilgilerinin dikkate alınması için true olarak ayarlayın yayında" (TTL) boyutunda olmalıdır. Bu durumda Edge, aşağıdaki yanıt başlıklarını kullanarak değerleri, Yayınlanma zamanı ayarlanırken <ExpirySettings>:

• Cache-Control s-maxage
• Cache-Control max-age
• Expires

Daha fazla bilgi için Önbellek girişi geçerlilik süresini ayarlama başlıklı makaleye bakın. bolca fırsat sunuyor.

<UseResponseCacheHeaders>false</UseResponseCacheHeaders>

Kullanım notları

Önbelleğe alınan her nesne için maksimum boyut 256 KB'tır. (Edge'nin nasıl çalıştığı hakkında işlem önbelleği hakkında bilgi için Önbellek dahili anahtar kelimeler.)

ResponseCache politikasındaki yapılandırmayla, Edge'in HTTP yanıtını eklemesini sağlayabilirsiniz üstbilgilerini tanımlamayı unutmayın. Bu bölümde, ilkesini kullandığınızdan emin olun.

Edge'in yanıt üstbilgilerini ResponseCache politikasıyla nasıl işlediği hakkında daha fazla bilgi edinmek için HTTP yanıt üstbilgileri için destek başlıklı makaleyi inceleyin.

Önbellek girişi son kullanma tarihi ayarlanıyor

Popülasyon Önbellek politikası etkinleştirildiğinde, <ExpirySettings> öğesi. ResponseCache politikasında Edge'i de kullanabilirsiniz yanıt başlıkları varsa bunları da göz önünde bulundurun.

Yanıt başlıklarını kullanmak için <UseResponseCacheHeaders> öğe değerini şu şekilde ayarlayın: doğru. Bu ayar, Edge'in yanıt başlıklarını dikkate almasına, bunları ayarlanan değerle karşılaştırmasına neden olur <ExpirySettings> ile ifade etmek için, ikisi arasındaki en düşük değeri kullanın. Zaman yanıt başlıklarını göz önünde bulundurarak Edge, takip etmek için:

Örneğin, bir yanıtın aşağıdaki değerlerle önbelleğe alındığını varsayalım:

• Cache-Control s-maxage değeri yok
• Cache-Control max-age için 300 değeri
• Üç günde Expires tarih
• 600 değerinde <ExpirySettings> TimeoutInSeconds değeri.

Bu durumda, Cache-Control max-age değeri TTL, <ExpirySettings> değerinden düşük olduğu ve Cache-Control s-maxage değeri yok (bu değer, max-age) tıklayın.

Önbellek anahtarını yapılandırma

Önbelleği Doldur politikası gibi genel amaçlı önbellek politikalarında olduğu gibi, <CacheKey> ve <Scope> öğelerini kullandığınız ResponseCache önbellek girişleri için önbellek anahtarı oluşturmayı yapılandırın. ResponseCache ile ayrıca önbellek anahtarları oluşturabilirsiniz anahtar değerlerine yanıt kabul etme başlıkları ekleyerek daha anlamlı sonuçlar elde edebilirsiniz.

Önbellek anahtarlarının yapılandırılması hakkında genel bilgiler için Önbellek anahtarlarıyla çalışma başlıklı makaleye bakın. Örneğin, Kabul etme üstbilgilerini kullanma hakkında daha fazla bilgi için bkz. <UseAcceptHeader>.

Önbellek şifreleme hakkında

Edge for Public Cloud: Önbellek yalnızca şurada şifrelenir: PCI ve HIPAA özellikli kuruluşlar. Bu kuruluşlar için şifreleme, kuruluş sırasında yapılandırılır. temel hazırlık.

Akış değişkenleri

Bir ResponseCache politikası yürütüldüğünde aşağıdaki önceden tanımlanmış Akış değişkenleri doldurulur. Akış değişkenleri hakkında daha fazla bilgi için Değişkenler referansı bölümüne bakın.

Hata kodları

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.

Fault variables

N/A

Example error response

N/A

Şema

Her politika türü bir XML şemasıyla (.xsd) tanımlanır. Referans olması amacıyla politika şemaları GitHub'da bulabilirsiniz.