Criterio LookupCache

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

Consente di configurare la modalità di recupero dei valori memorizzati nella cache in fase di esecuzione.

Questo criterio è destinato all'utilizzo nella memorizzazione nella cache a breve termine per uso generico. Viene utilizzato insieme al criterio di compilazione della cache (per la scrittura delle voci) e al criterio di aggiornamento della cache (per l'aggiornamento delle voci).

Per la memorizzazione nella cache delle risposte delle risorse di backend, consulta le norme relative alla cache delle risposte.

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare in questo criterio.

<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'elemento <CacheResource> in questa configurazione del criterio.

Per saperne di più sul datastore sottostante, consulta Informazioni interne sulla 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 che è stata recuperata dalla cache. La variabile deve essere scrivibile. Se la ricerca nella cache non restituisce un valore, la variabile non verrà impostata.

<AssignTo>variable_to_receive_cached_value</AssignTo>

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>

<CacheKey> genera il nome di ogni elemento di dati archiviato nella cache.

In fase di esecuzione, ai valori <KeyFragment> viene anteposto il valore dell'elemento <Scope> o il valore <Prefix>. Ad esempio, il seguente genera una chiave della cache di UserToken__apiAccessToken__<value_of_client_id>:

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

Elemento <CacheLookupTimeoutInSeconds>

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

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Elemento<CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

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

<CacheResource>cache_to_use</CacheResource>

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

Elemento <CacheKey>/<KeyFragment>

Specifica un valore da includere nella chiave della cache, creando uno spazio dei nomi per abbinare le richieste alle risposte memorizzate nella cache.

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

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 combinati (più il prefisso) vengono concatenati per creare la chiave della cache.

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

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

Attributi

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave della cache.

<Prefix>prefix_string</Prefix>

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

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

Elemento <Scope>

Enumerazione utilizzata per creare un prefisso per una chiave della cache quando nell'elemento <CacheKey> non è specificato un elemento <Prefix>.

<Scope>scope_enumeration</Scope>

L'impostazione <Scope> determina una chiave della cache che viene anteposta in base al valore <Scope>. Ad esempio, una chiave della cache assume la seguente forma quando lo scopo è impostato su Exclusive : orgName__envName__applicationName__proxy|TargetName__ [ serializedCacheKey ].

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

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

Valori accettabili

apifactory__test__weatherapi__16__default__apiAccessToken

Note sull'utilizzo

Utilizza questo criterio per la memorizzazione nella cache per uso generico. In fase di esecuzione, il criterio 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 della cache creata tramite la configurazione che combina gli elementi CacheKey e Scope. In altre parole, per recuperare un determinato valore aggiunto alla cache da un criterio PopulateCache, il criterio LookupCache deve avere elementi correlati alla chiave della cache configurati nello stesso modo del criterio PopulateCache.

La memorizzazione nella cache per uso generico con i criteri Populate Cache, LookupCache e InvalidateCache utilizza una cache configurata o una cache condivisa inclusa per impostazione predefinita. Nella maggior parte dei casi, la cache condivisa di base dovrebbe soddisfare le tue esigenze. Per utilizzare la cache predefinita, ometti semplicemente l'elemento <CacheResource>.

Per scoprire di più sulla configurazione delle cache, consulta Creare e modificare una cache dell'ambiente. Per saperne di più sul datastore sottostante, consulta Informazioni interne sulla cache.

Variabili di flusso

Le variabili di flusso possono essere utilizzate per configurare il comportamento di runtime dinamico per criteri e flussi, in base alle intestazioni HTTP o ai contenuti dei messaggi o al contesto disponibile nel flusso. Per ulteriori informazioni 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 un criterio 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