Norme di InvalidateCache

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Configura la modalità di eliminazione dei valori memorizzati nella cache.

Questa policy è destinata all'utilizzo nella memorizzazione nella cache a breve termine per scopi generici. Viene utilizzata insieme a Populate Cache policy (per la scrittura delle voci) e a Lookup Cache policy (per la lettura delle voci della cache).

Per la memorizzazione nella cache delle risposte delle risorse di backend, consulta la policy Response Cache.

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare in questa policy.

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

Attributi <InvalidateCache>

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

&lt;DisplayName&gt; elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Elemento <CacheContext>/<APIProxyName>

Specifica il nome dell'applicazione che ha aggiunto la voce della cache.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attributi

Elemento <CacheContext>

Specifica come costruire una chiave cache quando non viene specificato un valore dell'elemento Prefix o per cancellare le voci della cache aggiunte da un altro proxy 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>

Utilizzato per costruire la chiave cache. I valori di APIProxyName, ProxyName e TargetName sono obbligatori quando non viene utilizzato un prefisso CacheKey (ovvero un prefisso personalizzato) per cancellare le voci della cache aggiunte da un altro proxy API.

Elemento <CacheKey>

Configura un puntatore univoco a un insieme di dati archiviati nella cache.

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

<CacheKey> costruisce il nome di ogni insieme di dati archiviati nella cache.

In fase di runtime, i valori <KeyFragment> sono preceduti dal valore dell' <Scope> o dal valore <Prefix>. Ad esempio, quanto segue genera una chiave cache di UserToken__apiAccessToken__<value_of_client_id>:

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

Utilizza l'elemento <CacheKey> insieme a <Prefix> e <Scope>. Per saperne di più, consulta Utilizzo delle chiavi cache.

Elemento <CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

Ometti completamente questo elemento se questa policy (e le policy PopulateCache e LookupCache corrispondenti) utilizza la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Per saperne di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore da includere nella chiave cache, creando uno spazio dei nomi per la corrispondenza tra le richieste e le risposte memorizzate nella cache.

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

Può trattarsi di una chiave (un nome statico che fornisci) o di un valore (una voce dinamica impostata facendo riferimento a una variabile). Tutti i frammenti specificati combinati (più il prefisso) vengono concatenati per creare la chiave cache.

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

Utilizza l'elemento <KeyFragment> insieme a <Prefix> e <Scope>. Per saperne di più, consulta Utilizzo delle chiavi cache.

Attributi

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Utilizza questo valore anziché <Scope> quando vuoi specificare un valore personalizzato anziché un valore enumerato <Scope>. Se definito, <Prefix> antepone il valore della chiave cache alle voci scritte nella cache. Un valore dell'elemento <Prefix> sostituisce un valore dell'elemento <Scope>.

Utilizza l'elemento <Prefix> insieme a <CacheKey> e <Scope>. Per saperne di più, consulta Utilizzo delle chiavi cache.

Elemento <CacheContext>/<ProxyName>

Specifica il nome del proxy per cui i dati sono stati memorizzati nella cache.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Attributi

Elemento <PurgeChildEntries>

true per eliminare le voci della cache che condividono il valore impostato da un <KeyFragment> elemento configurato per questa policy. I valori in altre parti della chiave cache, ad esempio negli elementi <Prefix>, non vengono presi in considerazione.

Tieni presente che l'elemento <KeyFragment> deve essere specificato. In caso contrario, l'impostazione di true per <PurgeChildEntries> potrebbe comportare l'eliminazione di tutte le voci nella cache.

L'invalidazione di tutte le voci della cache dello stesso valore del frammento di chiave può essere un modo utile per eliminare più voci correlate contemporaneamente.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Elemento <Scope>

Enumerazione utilizzata per costruire un prefisso per una chiave cache quando non viene fornito un elemento <Prefix> nell'elemento <CacheKey>.

<Scope>scope_enumeration</Scope>

L'impostazione <Scope> determina una chiave cache anteposta in base a al valore <Scope>. Ad esempio, una chiave cache assume il seguente formato quando l'ambito è impostato su Exclusive:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Se è presente un elemento <Prefix> in <CacheKey>, questo sostituisce un valore dell'elemento <Scope>. I valori validi includono le enumerazioni riportate di seguito.

Utilizza l'elemento <Scope> insieme a <CacheKey> e <Prefix>. Per saperne di più, consulta Utilizzo delle chiavi cache.

Valori accettabili

apifactory__test__weatherapi__16__default__apiAccessToken

Elemento <CacheContext>/<TargetName>

Specifica il nome dell'endpoint di destinazione per cui i dati sono stati memorizzati nella cache.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Attributi

Note sull'utilizzo

La memorizzazione nella cache per scopi generici con la policy Populate Cache, la policy LookupCache e la policy InvalidateCache utilizza una cache che configuri o una cache condivisa inclusa per impostazione predefinita. Nella maggior parte dei casi, la cache condivisa sottostante dovrebbe soddisfare le tue esigenze. Per utilizzare questa cache, ometti l'elemento <CacheResource>.

Per saperne di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente. Per saperne di più sul datastore sottostante, consulta Interni della cache.

Codici di errore

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