Criterio LookupCache

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Configura la modalità di recupero dei valori memorizzati nella cache in fase di runtime.

Questa policy è destinata all'utilizzo nella memorizzazione nella cache a breve termine per scopi generici. Viene utilizzata insieme a con la policy Populate Cache (per la scrittura delle voci) e alla policy Invalidate Cache (per l'invalidazione delle voci).

Per la memorizzazione nella cache delle risposte delle risorse di backend, consulta la policy Response Cache.

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare in questa policy.

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

Una cache condivisa è inclusa per impostazione predefinita. Per utilizzare la cache condivisa, ometti l' <CacheResource> elemento nella configurazione di questa policy.

Per saperne di più sul datastore sottostante, consulta la sezione Interni della cache. Per saperne di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente.

Attributi <LookupCache>

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

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

Elemento <AssignTo>

Specifica la variabile a cui viene assegnata la voce della cache dopo essere stata recuperata dalla cache. La variabile deve essere scrivibile. Se la ricerca nella cache non recupera un valore, la variabile non verrà impostata.

<AssignTo>variable_to_receive_cached_value</AssignTo>

Elemento <CacheKey>

Configura un puntatore univoco a un insieme di dati archiviati nella cache.

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

<CacheKey> crea il nome di ogni insieme di dati archiviati nella cache.

In fase di runtime, i valori <KeyFragment> sono preceduti dal valore dell' <Scope> o dal valore <Prefix>. Ad esempio, il seguente codice genera una chiave cache UserToken__apiAccessToken__<value_of_client_id>:

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

Utilizza l'elemento <CacheKey> insieme a <Prefix> e <Scope>. Per saperne di più, consulta Utilizzare le chiavi cache.

Elemento <CacheLookupTimeoutInSeconds>

Specifica il numero di secondi dopo i quali una ricerca nella cache senza esito verrà considerata un fallimento della cache. In questo caso, il flusso riprende lungo il percorso di fallimento della cache.

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Elemento <CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

Ometti completamente questo elemento se questa policy (e le policy PopulateCache e InvalidateCache corrispondenti) utilizza la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Per saperne di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore da includere nella chiave cache, creando uno spazio dei nomi per la corrispondenza tra le richieste e le risposte memorizzate nella cache.

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

Può trattarsi di una chiave (un nome statico che fornisci) o di un valore (una voce dinamica impostata facendo riferimento a una variabile). Tutti i frammenti specificati combinati (più il prefisso) vengono concatenati per creare la chiave cache.

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

Utilizza l'elemento <KeyFragment> insieme a <Prefix> e <Scope>. Per saperne di più, consulta Utilizzare le chiavi cache.

Attributi

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

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

Utilizza l'elemento <Prefix> insieme a <CacheKey> e <Scope>. Per saperne di più, consulta Utilizzare le chiavi cache.

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>

L'impostazione <Scope> determina una chiave cache anteposta in base a al valore <Scope>. Ad esempio, una chiave cache assume il seguente formato quando l'ambito è impostato su Exclusive : orgName__envName__applicationName__proxy|TargetName__ [ serializedCacheKey ].

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

Utilizza l'elemento <Scope> insieme a <CacheKey> e <Prefix>. Per saperne di più, consulta Utilizzare le chiavi cache.

Valori accettabili

apifactory__test__weatherapi__16__default__apiAccessToken

Note sull'utilizzo

Utilizza questa policy per la memorizzazione nella cache per scopi generici. In fase di runtime, la policy LookupCache recupera un valore dalla cache, assegnandolo alla variabile specificata con l'elemento AssignTo (se non viene recuperato alcun valore, la variabile non verrà impostata). Cerca il valore in base a una chiave cache creata tramite la configurazione che combina gli elementi CacheKey e Scope. In altre parole, per recuperare un valore specifico aggiunto alla cache da una policy PopulateCache, la policy LookupCache deve avere elementi correlati alla chiave cache configurati nello stesso modo della policy PopulateCache policy.

La memorizzazione nella cache per scopi generici con la policy Populate Cache, policy LookupCache e la policy 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 la cache predefinita, ometti l'elemento <CacheResource>.

Per saperne di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente. Per saperne di più sul datastore sottostante, consulta la sezione Interni della cache.

Variabili di flusso

Le variabili di flusso possono essere utilizzate per configurare il comportamento di runtime dinamico per policy e flussi, in base alle intestazioni HTTP o al contenuto dei messaggi oppure al contesto disponibile nel flusso. Per saperne di più sulle variabili di flusso, consulta la sezione Riferimento alle variabili.

Le seguenti variabili di flusso predefinite sono disponibili dopo aver personalizzato il comportamento della cache definita in una policy LookupCache.

Codici di errore

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults.

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

N/A

Example error response

N/A