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:

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, puoi utilizzare l'elemento <DisplayName> per etichettare il criterio in l'editor proxy della UI 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 viene eseguito. Si tratta di un comportamento previsto per la maggior parte dei criteri.

Imposta su true per fare in modo che l'esecuzione del flusso continui anche dopo un criterio non riesce.

falso Facoltativo
enabled

Imposta il valore 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 è obsoleto.

falso Deprecato

&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

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>

Predefinito:

N/D

Presenza:

Obbligatorio

Tipo:

Stringa

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>

Predefinito:

N/D

Presenza:

Obbligatorio

Tipo:

N/D

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

Predefinito:

30

Presenza:

Facoltativo

Tipo:

Numero intero

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>

Predefinito:

N/D

Presenza:

Facoltativo

Tipo:

Stringa

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>

Predefinito:

N/D

Presenza:

Facoltativo

Tipo:

N/D

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

Attributo Tipo Predefinito Obbligatorio Descrizione
ref stringa No

La variabile da cui ottenere il valore. Non deve essere utilizzato se questo elemento contiene un valore letterale.

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Predefinito:

N/D

Presenza:

Facoltativo

Tipo:

Stringa

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>

Predefinito:

"Exclusive"

Presenza:

Facoltativo

Tipo:

Stringa

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

Global

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

Se definisci una voce <CacheKey> con <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 di cui è stato eseguito il deployment in un ambiente denominato "test" in un'organizzazione denominata "apifactory", i token di accesso vengono archiviati con la seguente chiave cache: apifactory__test__apiAccessToken.

Application

Il nome del proxy API viene utilizzato come prefisso.

La chiave cache è preceduta dal prefisso nel formato orgName__envName__applicationName.

Proxy

La configurazione di ProxyEndpoint viene utilizzata come prefisso.

La chiave cache è preceduta dal prefisso nel formato orgName__envName__applicationName__proxyEndpointName .

Target

La configurazione di TargetEndpoint viene utilizzata come prefisso.

La chiave cache è preceduta dal prefisso nel formato orgName__envName__applicationName__targetEndpointName .

Exclusive

Predefinita. Questa è la più specifica e, pertanto, presenta un rischio minimo di collisioni di spazi dei nomi all'interno di una determinata cache.

Il prefisso può assumere una delle due forme seguenti:

  • Se la policy è collegata al flusso ProxyEndpoint, il prefisso ha il formato ApiProxyName_ProxyEndpointName.
  • Se la policy è collegata a TargetEndpoint, il prefisso ha il formato ApiProxyName_TargetName.

La chiave cache è preceduta dal prefisso nel formato orgName__envName__applicationName__proxyNameITargetName

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

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.

Variabili Tipo Autorizzazione Descrizione
lookupcache.{policy-name}.cachename Stringa Sola lettura Restituisce il nome della cache utilizzato nella policy.
lookupcache.{policy-name}.cachekey Stringa Sola lettura Restituisce la chiave utilizzata.
lookupcache.{policy-name}.cachehit Booleano Sola lettura Il valore è vero se la policy ha trovato un valore per la chiave cache specificata.
lookupcache.{policy-name}.assignto Stringa Sola lettura Restituisce la variabile a cui è assegnata la 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> è impostato su un nome che non esiste nell'ambiente in cui viene eseguito il deployment del proxy API.
InvalidTimeout Se l'elemento <CacheLookupTimeoutInSeconds> è impostato su un numero negativo, il deployment del proxy API non va a buon fine.
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