Criterio LookupCache

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Consente di configurare il modo in cui i valori memorizzati nella cache devono essere recuperati in fase di runtime.

Questo criterio è destinato a essere utilizzato per la memorizzazione nella cache a breve termine per uso generico. Viene utilizzato in combinazione con il criterio PopulateCache (per la scrittura di voci) e il criterio InvalidateCache (per l'annullamento della convalida delle voci).

Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni di utilizzo, consulta Tipi di criteri.

Per la memorizzazione nella cache delle risposte delle risorse di backend, consulta il criterio ResponseCache.

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>

Per impostazione predefinita è inclusa una cache condivisa. Per utilizzare la cache condivisa, ometti l'elemento <CacheResource> in questa configurazione dei criteri.

Per saperne di più sul datastore sottostante, consulta Dati interni della cache. Per saperne di più sulla configurazione delle cache, consulta Memorizzazione nella cache per uso generico.

Attributi <LookupCache>

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo	Descrizione	Predefinito	Presenza
name	Il nome interno della norma. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Facoltativamente, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/A	Obbligatorio
continueOnError	Impostalo su false per restituire un errore in caso di errore di un criterio. Questo è il comportamento previsto per la maggior parte dei criteri. Imposta su true per fare in modo che l'esecuzione del flusso continui anche in caso di errore di un criterio. Vedi anche: Le regole di errore vengono attivate SOLO in stato di errore (informazioni su continueOnError) Gestione dei guasti all'interno del flusso di corrente	false	Facoltativo
enabled	Imposta il criterio su true per applicare il criterio. Impostala su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane associato a un flusso.	true	Facoltativo
async	Questo attributo è obsoleto.	false	Deprecata

Elemento <DisplayName>

Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Predefinito	N/A Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
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 accessibile in scrittura. Se la ricerca nella cache non recupera un valore, la variabile non verrà impostata.

<AssignTo>variable_to_receive_cached_value</AssignTo>

Predefinita:	N/D
Presenza:	Obbligatorio
Tipo:	Stringa

Elemento <CacheKey>

Configura un puntatore univoco a un dato memorizzato nella cache.

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

Predefinita:	N/D
Presenza:	Obbligatorio
Tipo:	N/D

<CacheKey> crea il nome di ogni dato archiviato nella cache.

In fase di runtime, i valori <KeyFragment> vengono anteposti al valore dell'elemento <Scope> o al valore <Prefix>. Ad esempio, quanto seguente genera una chiave cache di UserToken__apiAccessToken__<value_of_client_id>:

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

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

Elemento <CacheLookupTimeoutInSecond>

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

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Predefinita:	30
Presenza:	Facoltativo
Tipo:	Numero intero

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) utilizzano la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Predefinita:	N/D
Presenza:	Facoltativo
Tipo:	Stringa

Per saperne di più sulla configurazione delle cache, consulta Memorizzazione nella cache per uso generico.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore che deve essere incluso nella chiave cache. Specifica una variabile di cui rimuovere il riferimento con l'attributo ref o un valore fisso.

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

Predefinita:	N/D
Presenza:	Facoltativo
Tipo:	N/D

In fase di runtime, Apigee crea la chiave cache anteponendo il valore ottenuto dall'elemento <Scope> o dall'elemento <Prefix> a una concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per maggiori informazioni, consulta Utilizzo delle chiavi cache.

Attributi

Attributo	Tipo	Predefinito	Obbligatorio	Descrizione
rif	string		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>

Predefinita:	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 dall'elemento <Scope> o dall'elemento <Prefix> a una concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per maggiori informazioni, consulta Utilizzo delle 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>

Predefinita:	"Esclusivo"
Presenza:	Facoltativo
Tipo:	Stringa

L'impostazione <Scope> determina una chiave cache anteposta in base al valore <Scope>. Ad esempio, se l'ambito è impostato su Exclusive, una chiave cache avrà il formato seguente: 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 riportate di seguito.

Per ulteriori informazioni, consulta l'argomento Utilizzo delle chiavi cache.

Valori accettati

Global	La chiave cache è condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave cache è anteposta nel formato orgName __ envName __. Se definisci una voce <CacheKey> con l'apiAccessToken <KeyFragment> 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 "apilabs", i token di accesso vengono archiviati nella seguente chiave cache: apifactory__test__apiAccessToken.
Application	Il nome del proxy API viene utilizzato come prefisso. La chiave cache è anteposta nel formato orgName__envName__applicationName.
Proxy	Come prefisso viene utilizzata la configurazione dell'endpoint proxy. La chiave cache è anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName .
Target	La configurazione TargetEndpoint viene utilizzata come prefisso. Chiave cache anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .
Exclusive	Predefinito. Si tratta del più specifico e, di conseguenza, presenta un rischio minimo di collisioni dello spazio dei nomi all'interno di una determinata cache. Il prefisso può avere due forme: Se il criterio è associato al flusso ProxyEndpoint, il formato del prefisso è ApiProxyName_ProxyEndpointName. Se il criterio è associato a TargetEndpoint, il formato del prefisso è ApiProxyName_TargetName. Chiave 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 .

Note sull'utilizzo

Utilizza questo criterio per la memorizzazione nella cache per uso generico. In fase di runtime, il criterio LookupCache recupera un valore dalla cache, assegnando il valore alla variabile specificata con l'elementoAssignTo (se non viene recuperato alcun valore, la variabile non verrà impostata). Cerca il valore in base a una chiave cache creata tramite una 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 relativi alle chiavi della cache configurati nello stesso modo del criterio PopulateCache.

La memorizzazione nella cache per uso generico con il criterio PopulateCache, il criterio LookupCache e il Criterio InvalidateCache utilizza una cache configurata da te 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 semplicemente l'elemento <CacheResource>.

Per saperne di più sulla configurazione delle cache, consulta Memorizzazione nella cache per uso generico. Per saperne di più sul datastore sottostante, consulta Dati interni della 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 oppure al contesto disponibile nel flusso. Per saperne di più sulle variabili di flusso, consulta la documentazione di riferimento sulle variabili di flusso.

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

Variabili	Tipo	Autorizzazione	Descrizione
lookupcache.{nome-criteri}.nomecache	Stringa	Sola lettura	Restituisce il nome della cache utilizzato nel criterio.
lookupcache.{nome-criteri}.cachekey	Stringa	Sola lettura	Restituisce la chiave utilizzata.
lookupcache.{policy-name}.cachehit	Booleano	Sola lettura	True se il criterio ha trovato un valore per la chiave cache specificata.
lookupcache.{nome-criteri}.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.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correggi per informazioni dettagliate sulla risoluzione dei problemi.

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'processore di messaggi.

Variabili di errore

N/A

Esempio di risposta di errore

N/A