Norme di InvalidateCache

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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

Queste norme sono destinate all'utilizzo nella memorizzazione nella cache a breve termine per uso generico. Viene utilizzato in combinazione con la policy PopulateCache (per la scrittura delle voci) e la policy LookupCache (per la lettura delle voci della cache).

Per memorizzare nella cache le risposte delle risorse di backend, consulta le norme ResponseCache.

Queste norme sono estensibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o di utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni di utilizzo, consulta Tipi di criteri.

Nota:per svuotare una cache al di fuori di un flusso di messaggi senza norme, puoi utilizzare l'API Delete caches.

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare in questo criterio.

<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 dei criteri:

Attributo	Descrizione	Predefinito	Presence
name	Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/D	Obbligatorio
continueOnError	Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente	falso	Facoltativo
enabled	Imposta su true per applicare il criterio. Imposta su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.	true	Facoltativo
async	Questo attributo è stato ritirato.	falso	Deprecato

Elemento <DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Predefinito	N/D Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presence	Facoltativo
Tipo	Stringa

Elemento <CacheContext>/<APIProxyName>

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

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attributi

Attributo	Descrizione	Predefinito	Presenza	Tipo
ref	Variabile con il nome dell'applicazione.	N/D	Facoltativo	Stringa

Elemento <CacheContext>

Specifica come creare una chiave della 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 CacheKey. I valori per 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 memorizzati nella cache.

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

Predefinito:	N/D
Presenza:	Obbligatorio
Tipo:	N/D

<CacheKey> crea il nome di ogni dato memorizzato nella cache.

In fase di runtime, i valori di <KeyFragment> vengono anteposti al valore dell'elemento <Scope> o al valore di <Prefix>. Ad esempio, i seguenti generano una chiave della cache UserToken__apiAccessToken__<value_of_client_id>:

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

Utilizzi l'elemento <CacheKey> in combinazione con <Prefix> e <Scope>. Per maggiori informazioni, vedi Utilizzo delle chiavi della cache.

Elemento <CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

Ometti completamente questo elemento se questo criterio (e i criteri PopulateCache e LookupCache corrispondenti) utilizza la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Predefinito:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Per saperne di più sulla configurazione delle cache, consulta la sezione Memorizzazione nella cache per uso generico.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore da includere nella chiave cache. Specifica una variabile a cui fare dereferenziazione con l'attributo ref o un valore fisso.

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

Predefinito:	N/D
Presenza:	Facoltativo
Tipo:	N/D

In fase di runtime, Apigee crea la chiave della cache anteponendo il valore ottenuto dall'elemento <Scope> o dall'elemento <Prefix> a una concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per maggiori informazioni, vedi Utilizzo delle chiavi della cache.

Attributi

Attributo	Descrizione	Predefinito	Presenza	Tipo
ref	La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale.	N/D	Facoltativo	Stringa

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Predefinito:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Un elemento <Prefix> sostituisce qualsiasi elemento <Scope>.

In fase di runtime, Apigee crea la chiave della cache anteponendo il valore ottenuto dall'elemento <Scope> o dall'elemento <Prefix> a una concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per maggiori informazioni, vedi Utilizzo delle chiavi della cache.

Elemento <CacheContext>/<ProxyName>

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

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Predefinito:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Attributi

Attributo	Descrizione	Predefinito	Presenza	Tipo
ref	La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale.	N/D	Facoltativo	Stringa

Elemento <PurgeChildEntries>

true per eliminare le voci della cache che condividono lo stesso valore <Prefix> configurato per questo criterio, anche se le istanze del criterio PopolateCache che hanno caricato questi elementi nella cache hanno utilizzato anche vari elementi <KeyFragment>.

L'annullamento di tutte le voci della cache con lo stesso valore del prefisso consente di eliminare più voci correlate contemporaneamente.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Predefinito:	falso
Presenza:	Facoltativo
Tipo:	Booleano

Elemento <Scope>

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

<Scope>scope_enumeration</Scope>

Predefinito:	"Esclusiva"
Presenza:	Facoltativo
Tipo:	Stringa

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

orgName__envName__applicationName__proxy|TargetName__ [ serializedCacheKey ].

Se in <CacheKey> è presente un elemento <Prefix>, questo ha la precedenza su un valore dell'elemento <Scope>. Di seguito sono riportati i valori validi per l'elemento <Scope>.

Per maggiori informazioni, consulta Utilizzo delle chiavi della cache.

Valori accettabili

Valore dell'ambito	Descrizione
Global	La chiave della cache è condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave della cache viene anteposta nel formato orgName __ envName __. Se definisci una voce <CacheKey> con <KeyFragment> apiAccessToken e un ambito <Global>, ogni voce viene memorizzata come orgName__envName__apiAccessToken, seguito dal valore serializzato del token di accesso. Per un proxy API di cui è stato eseguito il deployment in un ambiente denominato "test" in un'organizzazione denominata "apifactory", i token di accesso verranno archiviati nella seguente chiave della cache: apifactory__test__apiAccessToken.
Application	Il nome del proxy API viene utilizzato come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName.
Proxy	La configurazione ProxyEndpoint viene utilizzata come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName__proxyEndpointName .
Target	La configurazione TargetEndpoint viene utilizzata come prefisso. Chiave della cache anteposta nel formato orgName__envName__applicationName__targetEndpointName .
Exclusive	Valore predefinito. Questo è il più specifico e quindi presenta un rischio minimo di collisioni di spazi dei nomi all'interno di una determinata cache. Il prefisso può avere due forme: Se il criterio è collegato al flusso ProxyEndpoint, il prefisso ha la forma ApiProxyName_ProxyEndpointName. Se il criterio è collegato a TargetEndpoint, il prefisso ha il formato ApiProxyName_TargetName. Chiave della cache anteposta nel modulo orgName__envName__applicationName__proxyNameITargetName Ad esempio, la stringa completa potrebbe avere il seguente aspetto: apifactory__test__weatherapi__default__apiAccessToken .

Elemento <CacheContext>/<TargetName>

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

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Predefinito:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Attributi

Attributo	Descrizione	Predefinito	Presenza	Tipo
ref	La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale.	N/D	Facoltativo	Stringa

Note sull'utilizzo

La memorizzazione nella cache per uso generico con i criteri PopulateCache, LookupCache e 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 semplicemente l'elemento <CacheResource>.

Per saperne di più sulla configurazione delle cache, consulta la sezione Memorizzazione nella cache per uso generico. 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.

Tip: Need help resolving an error? Click in the Fix column for detailed troubleshooting information.

Error name	Cause	Fix
InvalidCacheResourceReference	This error occurs if the <CacheResource> element in the InvalidateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
CacheNotFound	This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component.

Fault variables

N/A

Example error response

N/A