Questa pagina si applica a Apigee e Apigee ibridi.
Visualizza 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. È utilizzata in in combinazione con il criterio compileCache (per la scrittura delle voci) e 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 è una norma estendibile e il suo utilizzo potrebbe comportare costi o di utilizzo delle applicazioni, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni per l'utilizzo, consulta Tipi di criteri.
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>
<InvalidateCache> attributi
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 Facoltativamente, utilizza l'elemento |
N/A | Obbligatorio |
continueOnError |
Impostalo su Imposta su |
false | Facoltativo |
enabled |
Imposta il criterio su Impostala su |
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 |
---|---|
Presenza | Facoltativo |
Tipo | Stringa |
<CacheContext>/<APIProxyName> elemento
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 |
---|---|---|---|---|
riferimento | Variabile con il nome dell'applicazione. | N/D | Facoltativo | Stringa |
<CacheContext> elemento
Specifica come creare una chiave cache quando il valore di un elemento Prefix
non è
specificato 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>
Utilizzata per creare la CacheKey. I valori per APIProxyName, ProxyName e TargetName sono obbligatorio quando non viene utilizzato un prefisso CacheKey (ovvero un prefisso personalizzato) per cancellare le voci della cache aggiunto da un altro proxy API.
<CacheKey> elemento
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/D |
Presenza: |
Obbligatorio |
Tipo: |
N/D |
<CacheKey>
genera il nome di ogni dato archiviato nell'
.
In fase di runtime, i valori <KeyFragment>
vengono anteposti al
Valore dell'elemento <Scope>
o valore <Prefix>
. Ad esempio,
la seguente determina la creazione di una chiave 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 ulteriori informazioni, vedi
Utilizzo della cache
chiave.
<CacheResource> elemento
Specifica la cache in cui devono essere archiviati i messaggi.
Ometti completamente questo elemento se questo criterio (e i valori corrispondenti i criteri LookupCache) utilizzano la cache condivisa inclusa.
<CacheResource>cache_to_use</CacheResource>
Predefinita: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
Per saperne di più sulla configurazione delle cache, consulta l'articolo Memorizzazione nella cache per uso generico.
<CacheKey>/<KeyFragment> elemento
Specifica un valore che deve essere incluso nella chiave cache. Specifica una variabile di cui rimuovere il riferimento
con l'attributo ref
o un valore fisso.
<KeyFragment ref="variable_name"/> <KeyFragment>literal_string</KeyFragment>
Predefinita: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
N/D |
In fase di runtime, Apigee crea la chiave cache anteponendo il valore ottenuto
<Scope>
o <Prefix>
in un elemento
concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>
.
Per ulteriori informazioni, vedi
Operazione in corso
con chiavi cache.
Attributi
Attributo | Descrizione | Predefinito | Presenza | Tipo |
---|---|---|---|---|
riferimento | La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale. | N/D | Facoltativo | Stringa |
<CacheKey>/<Prefix> elemento
Specifica un valore da utilizzare come prefisso della chiave cache.
<Prefix>prefix_string</Prefix>
Predefinita: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
Un elemento <Prefix>
sostituisce qualsiasi elemento <Scope>
.
In fase di runtime, Apigee crea la chiave cache anteponendo il valore ottenuto
<Scope>
o <Prefix>
in un elemento
concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>
.
Per ulteriori informazioni, vedi
Operazione in corso
con chiavi cache.
<CacheContext>/<ProxyName> elemento
Specifica il nome del proxy per cui i dati sono stati memorizzati nella cache.
<ProxyName>proxy_for_which_data_was_cached</ProxyName>
Predefinita: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
Attributi
Attributo | Descrizione | Predefinito | Presenza | Tipo |
---|---|---|---|---|
riferimento | La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale. | N/D | Facoltativo | Stringa |
<PurgeChildEntries> elemento
true
per eliminare definitivamente le voci della cache che condividono lo stesso <Prefix>
valore configurato per questo criterio, anche se il criterio compileCache
che aveva caricato questi elementi nella cache
utilizzavano anche vari
<KeyFragment>
elementi.
La convalida di tutte le voci della cache con lo stesso valore di prefisso consente di eliminare contemporaneamente più voci correlate.
<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>
Predefinita: |
falso |
Presenza: |
Facoltativo |
Tipo: |
Booleano |
<Scope> elemento
Enumerazione utilizzata per costruire un prefisso per una chiave cache quando <Prefix>
non è fornito nell'elemento <CacheKey>
.
<Scope>scope_enumeration</Scope>
Predefinita: |
"Esclusiva" |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
L'impostazione <Scope>
determina una chiave cache che viene anteposta in base al
il 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 un elemento <Prefix>
è presente in <CacheKey>
,
sostituisce un valore dell'elemento <Scope>
. Valori validi per <Scope>
sono mostrati di seguito.
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 cache è anteposto nel formato orgName __ envName __. Se definisci una voce |
Application |
Il nome del proxy API viene utilizzato come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName. |
Proxy |
Come prefisso viene utilizzata la configurazione ProxyEndpoint. La chiave della cache viene anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName di Google. |
Target |
Come prefisso viene utilizzata la configurazione TargetEndpoint. Chiave cache anteposta nel modulo orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName di Google. |
Exclusive |
Predefinita. Si tratta della risposta più specifica e presenta quindi un rischio minimo di spazio dei nomi di conflitti all'interno di una determinata cache. Il prefisso può essere di due tipi:
Chiave cache anteposta nel modulo orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName Ad esempio, la stringa completa potrebbe essere simile alla seguente: apifactory__test__weatherapi__16__default__apiAccessToken. |
<CacheContext>/<TargetName> elemento
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/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
Attributi
Attributo | Descrizione | Predefinito | Presenza | Tipo |
---|---|---|---|---|
riferimento | 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
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
predefinito. 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.
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. |
build |
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. | build |
Variabili di errore
N/A
Esempio di risposta di errore
N/A