Criterio InvalidateCache

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

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

Questo criterio è destinato a essere utilizzato per la memorizzazione nella cache a breve termine per uso generico. Viene utilizzato in combinazione con il criterio popola cache (per la scrittura di voci) e il criterio cache di ricerca (per la lettura delle voci della cache).

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

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

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 Predefinito Presenza Tipo
rif Variabile con il nome dell'applicazione. N/A Facoltativo Stringa

Elemento <CacheContext>

Specifica come creare una chiave cache quando non è 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>

Utilizzata per creare la CacheKey. I valori per APIProxyName, ProxyName e TargetName sono obbligatori quando un prefisso CacheKey (ossia un prefisso personalizzato) non viene utilizzato 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>

Predefinito:

N/A

Presenza:

Obbligatorie

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>

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

Elemento <CacheResource>

Specifica la cache in cui archiviare i messaggi.

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

<CacheResource>cache_to_use</CacheResource>

Predefinito:

N/A

Presenza:

Facoltativo

Tipo:

Stringa

Per saperne di più sulla configurazione delle cache, consulta Creazione e modifica di una cache di ambiente.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore che deve essere incluso nella chiave cache, creando uno spazio dei nomi per le richieste corrispondenti alle risposte memorizzate nella cache.

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

Predefinito:

N/A

Presenza:

Facoltativo

Tipo:

N/A

Può essere una chiave (un nome statico fornito da te) o un valore (una voce dinamica impostata facendo riferimento a una variabile). Tutti i frammenti specificati (più il prefisso) vengono concatenati per creare la chiave cache.

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

Puoi utilizzare l'elemento <KeyFragment> insieme a <Prefix> e <Scope>. Per ulteriori informazioni, consulta Utilizzo delle chiavi cache.

Attributi

Attributo Descrizione Predefinito Presenza Tipo
rif La variabile da cui ricavare 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>

Predefinito:

N/A

Presenza:

Facoltativo

Tipo:

Stringa

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

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

Elemento <CacheContext>/<ProxyName>

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

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Predefinito:

N/A

Presenza:

Facoltativo

Tipo:

Stringa

Attributi

Attributo Descrizione Predefinito Presenza Tipo
rif La variabile da cui ricavare 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 il valore impostato da un elemento <KeyFragment> configurato per questo criterio. 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 definitiva di tutte le voci della cache.

La convalida di tutte le voci della cache relative allo stesso valore del frammento di chiave può essere un modo utile per eliminare definitivamente più voci correlate contemporaneamente.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Predefinito:

false

Presenza:

Facoltativo

Tipo:

Booleano

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>

Predefinito:

"Esclusiva"

Presenza:

Facoltativo

Tipo:

Stringa

L'impostazione <Scope> determina una chiave cache da anteporre al valore <Scope>. Ad esempio, una chiave cache assumerà il seguente formato quando l'ambito è impostato su Exclusive:

orgName__envName__applicazioneName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

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

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

Valori accettabili

Valore ambito Descrizione
Global

La chiave cache è condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave cache è anteposta nel formato orgName __ orgName __.

Se definisci una voce <CacheKey> con l'apiAccessToken <KeyFragment> e un ambito <Global>, ogni voce viene archiviata come orgName__envName__apiAccessToken, seguita 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 "apilabs", 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 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.

La chiave cache è anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .

Exclusive

Predefinita. Questa è la più specifica e pertanto presenta un rischio minimo di collisioni dello spazio dei nomi all'interno di una data cache.

Il prefisso può avere due forme:

  • Se il criterio è associato al flusso ProxyEndpoint, il prefisso è nel formato ApiProxyName_ProxyEndpointName.
  • Se il criterio è collegato all'indirizzo TargetEndpoint, il formato del prefisso è ApiProxyName_TargetName.

Chiave cache anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

Ad esempio, la stringa completa potrebbe avere il seguente aspetto:

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>

Predefinito:

N/A

Presenza:

Facoltativo

Tipo:

Stringa

Attributi

Attributo Descrizione Predefinito Presenza Tipo
rif La variabile da cui ricavare 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 Popula cache, 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 Creazione e modifica di una cache di ambiente. Per saperne di più sull'archivio dati sottostante, consulta Elementi interni 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.
CacheNotFound Questo errore si verifica se la cache specifica menzionata nel messaggio di errore non è stata creata su un componente specifico dell'elaboratore di messaggi.

Variabili di errore

N/A

Esempio di risposta di errore

N/A