Criterio InvalidateCache

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Consente di configurare il modo in cui i valori memorizzati nella cache devono essere eliminati definitivamente dalla cache.

Questo criterio è destinato all'uso nella memorizzazione nella cache a breve termine per uso generico. Viene utilizzato insieme al criterio compileCache (per la scrittura delle voci) e al criterio LookupCache (per la lettura delle voci della cache).

Per memorizzare nella cache le risposte delle risorse di backend, consulta il criterio diResponseCache.

Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta la pagina Tipi di criteri.

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

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare su 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	Presenza
name	Il nome interno della norma. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Facoltativamente, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/A	Obbligatorio
continueOnError	Impostalo su false per restituire un errore in caso di errore di un criterio. Questo è il comportamento previsto per la maggior parte dei criteri. Imposta su true per fare in modo che l'esecuzione del flusso continui anche in caso di errore di un criterio. Vedi anche: Le regole di errore vengono attivate SOLO in stato di errore (informazioni su continueOnError) Gestione dei guasti all'interno del flusso di corrente	false	Facoltativo
enabled	Imposta il criterio su true per applicare il criterio. Impostala su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane associato a un flusso.	true	Facoltativo
async	Questo attributo è obsoleto.	false	Deprecata

Elemento <DisplayName>

Utilizzalo in aggiunta 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/A Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presenza	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	Predefinita	Presenza	Tipo
riferimento	Variabile con il nome dell'applicazione.	N/A	Facoltativo	Stringa

Elemento <CacheContext>

Consente di specificare come creare una chiave cache quando non viene specificato un valore dell'elemento Prefix o come 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>

Utilizzata per creare 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 dato archiviato nella cache.

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

Predefinita:	N/A
Presenza:	Obbligatorio
Tipo:	N/A

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

In fase di runtime, i valori <KeyFragment> vengono anteposti al valore dell'elemento <Scope> o al 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>

Utilizzi l'elemento <CacheKey> insieme a <Prefix> e <Scope>. Per maggiori informazioni, consulta Utilizzo delle chiavi cache.

Elemento <CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

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

<CacheResource>cache_to_use</CacheResource>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

Per saperne di più sulla configurazione delle cache, consulta l'articolo Memorizzazione nella cache per uso generico.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore che deve essere incluso nella chiave cache. Specifica una variabile di cui rimuovere il riferimento con l'attributo ref o con un valore fisso.

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

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	N/A

In fase di runtime, Apigee crea la chiave 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, consulta Utilizzo delle chiavi cache.

Attributi

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

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

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

In fase di runtime, Apigee crea la chiave 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, 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>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

Attributi

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

Elemento <PurgeChildEntries>

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

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

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Predefinita:	false
Presenza:	Facoltativo
Tipo:	Booleano

Elemento <Scope>

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

<Scope>scope_enumeration</Scope>

Predefinita:	"Esclusiva"
Presenza:	Facoltativo
Tipo:	String

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

orgName__envName__applicationName__deployedRevisionNumber__proxy|NomeTarget__ [ serializedCacheKey ].

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

Per ulteriori informazioni, vedi Utilizzo delle chiavi cache.

Valori accettabili

Valore ambito	Descrizione
Global	La chiave cache viene condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave della cache è anteposta nel formato orgName __ envName __. Se definisci una voce <CacheKey> con <KeyFragment> apiAccessToken e un ambito <Global>, ogni voce viene archiviata 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 vengono archiviati nella seguente chiave cache: apifactory__test__apiAccessToken.
Application	Il nome del proxy API viene utilizzato come prefisso. La chiave della cache è anteposta nel formato orgName__envName__applicationName.
Proxy	Come prefisso viene utilizzata la configurazione ProxyEndpoint. La chiave cache è anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName .
Target	Come prefisso viene utilizzata la configurazione TargetEndpoint. Chiave cache anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .
Exclusive	Predefinita. Si tratta del tipo più specifico e, di conseguenza, presenta il rischio minimo di collisioni degli spazi dei nomi all'interno di una determinata cache. Il prefisso può essere di due tipi: Se il criterio è collegato al flusso ProxyEndpoint, il formato del prefisso è ApiProxyName_ProxyEndpointName. Se il criterio viene collegato a TargetEndpoint, il prefisso è nel formato ApiProxyName_TargetName. Chiave cache anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName Ad esempio, la stringa completa potrebbe essere simile alla seguente: apifactory__test__weatherapi__16__default__apiAccessToken .

Elemento <CacheContext>/<TargetName>

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

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

Attributi

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

Note sull'utilizzo

La memorizzazione nella cache per uso generico con il criterio compileCache, il criterio LookupCache e il criterio InvalidateCache utilizza una cache configurata da te 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 l'articolo Memorizzazione nella cache per uso generico. Per scoprire di più sul datastore sottostante, consulta Informazioni interne della cache.

Codici di errore

Questa sezione descrive i messaggi di errore e le variabili di flusso che vengono impostati quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se stai sviluppando regole di errore per un proxy. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Prefisso codice di errore

N/A

Errori di runtime

Questo criterio non genera errori di runtime.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correggi per informazioni dettagliate sulla risoluzione dei problemi.

Nome errore	Causa	Correggi
InvalidCacheResourceReference	Questo errore si verifica se l'elemento <CacheResource> nel criterio InvalidateCache è impostato su un nome che non esiste nell'ambiente in cui viene eseguito il deployment del proxy API.
CacheNotFound	Questo errore si verifica se la cache specifica menzionata nel messaggio di errore non è stata creata su un componente specifico dell'processore di messaggi.

Variabili di errore

N/A

Esempio di risposta di errore

N/A