Criterio InvalidateCache

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

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

Questo criterio è destinato all'utilizzo 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 la norma ResponseCache.

Questo criterio è un criterio estensibile e il suo utilizzo potrebbe comportare implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni sull'utilizzo, consulta 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 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 del criterio. Il valore dell'attributo name può Deve 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 il valore su false per restituire un errore quando un criterio non funziona. Si tratta di un comportamento previsto comportamento 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 false per disattivare il criterio. Il criterio non verrà applicata anche se rimane collegata a un flusso.	true	Facoltativo
async	Questo attributo è stato ritirato.	falso	Ritirato

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

Predefinito	N/D Se ometti questo elemento, il valore dell'attributo name del criterio è in uso.
Presenza	Facoltativo
Tipo	Stringa

&lt;CacheContext&gt;/&lt;APIProxyName&gt; 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
ref	Variabile con il nome dell'applicazione.	N/D	Facoltativo	Stringa

&lt;CacheContext&gt; 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>

Utilizzato per creare la chiave della cache. 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.

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>

Valore predefinito:	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__&lt;value_of_client_id&gt;:

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

L'elemento <CacheKey> viene utilizzato in combinazione con <Prefix> e <Scope>. Per ulteriori informazioni, consulta Utilizzo delle chiavi della cache.

&lt;CacheResource&gt; 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>

Valore predefinito:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Per scoprire di più sulla configurazione delle cache, consulta la sezione Cache per uso generale.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore da includere nella chiave della cache. Specifica una variabile da annullare il riferimento con l'attributo ref o un valore fisso.

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

Valore predefinito:	N/D
Presenza:	Facoltativo
Tipo:	N/D

In fase di esecuzione, 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 ulteriori informazioni, consulta 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 della cache.

<Prefix>prefix_string</Prefix>

Valore predefinito:	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.

&lt;CacheContext&gt;/&lt;ProxyName&gt; elemento

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

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

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

L'invalidazione di tutte le voci della cache dello stesso valore di prefisso ti consente di eliminare più voci correlate contemporaneamente.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Predefinita:	falso
Presenza:	Facoltativo
Tipo:	Booleano

&lt;Scope&gt; 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 della cache assumerebbe la seguente forma 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, consulta Utilizzo delle chiavi della 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 viene premessa nel formato orgName __ envName __. Se definisci una voce <CacheKey> con il valore <KeyFragment> apiAccessToken e un ambito <Global>, ogni voce viene archiviata come orgName__envName__apiAccessToken, seguita dal valore serializzato del token di accesso. Per un proxy API distribuito in un ambiente denominato 'test' in un'organizzazione chiamata "apifactory", i token di accesso venivano archiviati seguente chiave 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 di ProxyEndpoint viene utilizzata come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName di Google.
Target	Come prefisso viene utilizzata la configurazione TargetEndpoint. Chiave della cache anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .
Exclusive	Valore predefinito. 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: Se il criterio è associato al flusso ProxyEndpoint, il prefisso è del formato ApiProxyName_ProxyEndpointName. Se il criterio è allegato a TargetEndpoint, il prefisso è nel formato ApiProxyName_TargetName. Chiave della 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>

Predefinita:	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 configurata 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 scoprire di più sulla configurazione delle cache, consulta la sezione Cache per uso generale. Per saperne di più sul datastore sottostante, consulta Informazioni interne sulla cache.

Codici di errore

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

Prefisso del codice di errore

N/D

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 Correzione per informazioni dettagliate sulla risoluzione dei problemi.

Nome dell'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 indicata nel messaggio di errore non è stata creata su un componente di processore di messaggi specifico.

Variabili di errore

N/D

Esempio di risposta di errore

N/D