Criterio InvalidateCache

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione 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 all'uso nella memorizzazione nella cache a breve termine per uso generico. È utilizzata in in combinazione con il comando Compila Criterio della cache (per la scrittura delle voci) e Criterio della cache di ricerca (per la lettura delle voci della cache).

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

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 del criterio:

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

<CacheContext>/<APIProxyName> elemento

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

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attributi

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

<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 delle chiavi cache.

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

Per ulteriori informazioni sulla configurazione delle cache, consulta Creare e modificare un ambiente Cache.

<CacheKey>/<KeyFragment> elemento

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

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

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

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

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

Attributi

<CacheKey>/<Prefix> elemento

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

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

Utilizzi l'elemento <Prefix> in combinazione con <CacheKey> e <Scope>. Per ulteriori informazioni, vedi Utilizzo delle 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>

Attributi

<PurgeChildEntries> elemento

true per eliminare definitivamente le voci della cache che condividono il valore impostato da un <KeyFragment> elemento configurato per questo criterio. Valori nelle altre parti ad esempio negli elementi <Prefix>, non vengono prese in considerazione.

Tieni presente che è necessario specificare l'elemento <KeyFragment>. In caso contrario, l'impostazione true per <PurgeChildEntries> potrebbe comportare l'eliminazione definitiva di tutte le voci in nella cache.

La invalidazione di tutte le voci della cache dello stesso valore di frammento di chiave può essere un modo utile eliminare contemporaneamente più voci correlate.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

<Scope> elemento

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

<Scope>scope_enumeration</Scope>

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>. I valori validi includono le enumerazioni di seguito.

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

Valori accettabili

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>

Attributi

Note sull'utilizzo

Memorizzazione nella cache per uso generico con il criterio Compilazione cache, 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 ulteriori informazioni sulla configurazione delle cache, consulta Creare e modificare un ambiente Cache. 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.

Variabili di errore

N/A

Esempio di risposta di errore

N/A