Nieprawidłowa zasada dotycząca pamięci podręcznej

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Konfiguruje sposób trwałego usuwania wartości z pamięci podręcznej.

Ta zasada jest przeznaczona do krótkoterminowego buforowania ogólnego przeznaczenia. Używany w konsola z funkcją Wypełnij Zasada pamięci podręcznej (do zapisywania wpisów) i zasady wyszukiwania pamięci podręcznej (do odczytu wpisów pamięci podręcznej).

Informacje o buforowaniu odpowiedzi zasobów backendu znajdziesz w dokumentacji Zasada pamięci podręcznej odpowiedzi.

Odwołanie do elementu

Poniżej znajduje się lista elementów, które można skonfigurować w tej zasadzie.

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

<InvalidateCache> atrybuty

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

<DisplayName> element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

<CacheContext>/<APIProxyName> element

Określa nazwę aplikacji, która dodała wpis pamięci podręcznej.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Atrybuty

<CacheContext> element

Określa, jak utworzyć klucz pamięci podręcznej, gdy wartość elementu Prefix nie jest wartością lub wyczyścić wpisy w pamięci podręcznej dodane przez inny serwer proxy interfejsu API.

<CacheContext>
  <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName>
  <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName>
  <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName>
</CacheContext>

Służy do tworzenia obiektu CacheKey. Wartości APIProxyName, ProxyName i TargetName to obowiązkowe, gdy prefiks CacheKey (czyli prefiks niestandardowy) nie jest używany do czyszczenia wpisów pamięci podręcznej dodany przez inny serwer proxy interfejsu API.

<CacheKey> element

Konfiguruje unikalny wskaźnik danych przechowywanych w pamięci podręcznej.

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

<CacheKey> tworzy nazwę każdego elementu danych przechowywanych w pamięci podręcznej.

W czasie działania wartości <KeyFragment> są dodawane prefiksem Wartość elementu <Scope> lub <Prefix>. Na przykład parametr daje w rezultacie klucz pamięci podręcznej równy UserToken__apiAccessToken__<value_of_client_id>:

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

Elementu <CacheKey> używasz w połączeniu z: <Prefix> i <Scope>. Więcej informacji znajdziesz w artykule na temat pracy z kluczami pamięci podręcznej.

<CacheResource> element

Określa pamięć podręczną, w której mają być przechowywane wiadomości.

Pomiń ten element, jeśli ta zasada (i odpowiednie pole PopulationCache oraz zasady lookupCache) korzystają z uwzględnionej współdzielonej pamięci podręcznej.

<CacheResource>cache_to_use</CacheResource>

Więcej informacji o konfigurowaniu pamięci podręcznych znajdziesz w sekcji Tworzenie i edytowanie środowiska Cache.

<CacheKey>/<KeyFragment> element

Określa wartość, która powinna być uwzględniona w kluczu pamięci podręcznej, tworząc przestrzeń nazw na potrzeby dopasowywania żądań odpowiedzi w pamięci podręcznej.

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

Może to być klucz (podana przez Ciebie statyczna nazwa) lub wartość (wpis dynamiczny ustawiony przez odwołania do zmiennej). Wszystkie określone fragmenty łącznie (plus prefiks) są połączone z utwórz klucz pamięci podręcznej.

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

Elementu <KeyFragment> używasz w połączeniu z: <Prefix> i <Scope>. Więcej informacji znajdziesz w artykule na temat pracy z kluczami pamięci podręcznej.

Atrybuty

<CacheKey>/<Prefix> element

Określa wartość, która ma być używana jako prefiks klucza pamięci podręcznej.

<Prefix>prefix_string</Prefix>

Użyj tej wartości zamiast <Scope>, jeśli chcesz określić własną wartość zamiast wartości wyliczanej <Scope>. Jeśli zostanie określona, <Prefix> dodaje na początku wartość klucza pamięci podręcznej dla wpisów zapisanych w pamięci podręcznej. O Wartość elementu <Prefix> zastępuje element <Scope> .

Elementu <Prefix> używasz w połączeniu z: <CacheKey> i <Scope>. Więcej informacji znajdziesz w artykule na temat pracy z kluczami pamięci podręcznej.

<CacheContext>/<ProxyName> element

Określa nazwę serwera proxy, dla którego dane zostały zapisane w pamięci podręcznej.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Atrybuty

<PurgeChildEntries> element

true, aby trwale usunąć wpisy pamięci podręcznej, które mają wartość ustawioną przez Dla tej zasady skonfigurowano <KeyFragment> element. Wartości w innych częściach klucza pamięci podręcznej, np. w elementach <Prefix>.

Pamiętaj, że musisz określić element <KeyFragment>. Jeśli nie, Ustawienie wartości prawda dla <PurgeChildEntries> może spowodować trwałe usunięcie wszystkich wpisów w pamięci podręcznej.

Unieważnienie wszystkich wpisów w pamięci podręcznej dla tej samej wartości fragmentu klucza może być użytecznym sposobem i trwale usuń wiele powiązanych wpisów jednocześnie.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

<Scope> element

Wyliczenie używane do tworzenia prefiksu klucza pamięci podręcznej, gdy <Prefix> element <CacheKey> nie zawiera elementu.

<Scope>scope_enumeration</Scope>

Ustawienie <Scope> określa klucz pamięci podręcznej, który jest dodawany zgodnie z wartość <Scope>. Na przykład klucz pamięci podręcznej może mieć następującą postać, gdy: zakres jest ustawiony na Exclusive:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Jeśli element <Prefix> występuje w elemencie <CacheKey>, zastępuje wartość elementu <Scope>. Prawidłowe wartości obejmują wyliczenia poniżej.

Elementu <Scope> używasz w połączeniu z: <CacheKey> i <Prefix>. Więcej informacji znajdziesz w artykule na temat pracy z kluczami pamięci podręcznej.

Dopuszczalne wartości

apifactory__test__weatherapi__16__default__apiAccessToken

<CacheContext>/<TargetName> element

Określa nazwę docelowego punktu końcowego, dla którego dane zostały zapisane w pamięci podręcznej.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Atrybuty

Zastosowanie

buforowanie do zwykłych obciążeń z użyciem zasad wypełniania pamięci podręcznej, zasady szeregowania pamięci podręcznej oraz Zasada invalidateCache używa skonfigurowanej przez Ciebie pamięci podręcznej lub współdzielonej pamięci podręcznej zawartej przez wartość domyślną. W większości przypadków bazowa współdzielona pamięć podręczna powinna spełniać Twoje potrzeby. Aby użyć tej pamięci podręcznej, po prostu pominąć element <CacheResource>.

Więcej informacji o konfigurowaniu pamięci podręcznych znajdziesz w sekcji Tworzenie i edytowanie środowiska Cache. Więcej informacji o bazowym magazynie danych znajdziesz w artykule Wewnętrzne pamięci podręcznej.

Kody błędów

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