Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Configura la modalità di recupero dei valori memorizzati nella cache in fase di runtime.
Queste norme sono destinate all'utilizzo nella memorizzazione nella cache a breve termine per uso generico. Viene utilizzato in combinazione con il criterio PopolateCache (per la scrittura delle voci) e il criterio InvalidateCache (per l'invalidazione delle voci).
Queste norme sono estensibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o di utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni di utilizzo, consulta Tipi di criteri.
Per memorizzare nella cache le risposte delle risorse di backend, consulta le norme 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 Interni della cache. Per saperne di più sulla configurazione delle cache, consulta la sezione 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 | Presence |
---|---|---|---|
name |
Il nome interno del criterio. Il valore dell'attributo Se vuoi, utilizza l'elemento |
N/D | Obbligatorio |
continueOnError |
Imposta su Imposta su |
falso | Facoltativo |
enabled |
Imposta su Imposta su |
true | Facoltativo |
async |
Questo attributo è stato ritirato. |
falso | Deprecato |
Elemento <DisplayName>
Da utilizzare insieme 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/D Se ometti questo elemento, viene utilizzato il valore dell'attributo |
---|---|
Presence | 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 memorizzati 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 dato memorizzato nella cache.
In fase di runtime, i valori di <KeyFragment>
vengono anteposti al valore dell'elemento <Scope>
o al valore di <Prefix>
. Ad esempio, i
seguenti generano una chiave della 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 maggiori informazioni, consulta Utilizzo delle chiavi della cache.
Elemento <CacheLookupTimeoutInSeconds>
Specifica il numero di secondi dopo i quali una ricerca nella cache senza esito positivo verrà considerata un fallimento della cache. In questo caso, il flusso riprende lungo il percorso di mancato riscontro nella cache.
<CacheLookupTimeoutInSeconds>12</CacheLookupTimeoutInSeconds>
Predefinito: |
12 |
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 la sezione Memorizzazione nella cache per uso generico.
Elemento <CacheKey>/<KeyFragment>
Specifica un valore da includere nella chiave cache. Specifica una variabile a cui fare dereferenziazione
con l'attributo ref
o un valore fisso.
<KeyFragment ref="variable_name"/> <KeyFragment>literal_string</KeyFragment>
Predefinito: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
N/D |
In fase di runtime, Apigee crea la chiave della 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, vedi
Utilizzo
delle chiavi della cache.
Attributi
Attributo | Tipo | Predefinito | Obbligatorio | Descrizione |
---|---|---|---|---|
ref | 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>
Predefinito: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
Un elemento <Prefix>
sostituisce qualsiasi elemento <Scope>
.
In fase di runtime, Apigee crea la chiave della 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, vedi
Utilizzo
delle chiavi della cache.
Elemento <Scope>
Enumerazione utilizzata per creare un prefisso per una chiave della cache quando un elemento <Prefix>
non viene fornito nell'elemento <CacheKey>
.
<Scope>scope_enumeration</Scope>
Predefinito: |
"Esclusiva" |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
L'impostazione <Scope>
determina una chiave della cache anteposta in base al valore <Scope>
. Ad esempio, una chiave della cache assume il seguente formato quando
l'ambito è impostato su Exclusive
:
orgName__envName__applicationName__proxy|TargetName__
[ serializedCacheKey ].
Se in <CacheKey>
è presente un elemento <Prefix>
, questo
ha la precedenza su un valore dell'elemento <Scope>
. I valori validi includono le enumerazioni
di seguito.
Per maggiori informazioni, consulta Utilizzo delle chiavi della cache.
Valori accettabili
Global |
La chiave della cache è condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave della cache viene anteposta nel formato orgName __ envName __. Se definisci una voce |
Application |
Il nome del proxy API viene utilizzato come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName. |
Proxy |
La configurazione ProxyEndpoint viene utilizzata come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName__proxyEndpointName . |
Target |
La configurazione TargetEndpoint viene utilizzata come prefisso. Chiave della cache anteposta nel formato orgName__envName__applicationName__targetEndpointName . |
Exclusive |
Valore predefinito. Questo è il più specifico e quindi presenta un rischio minimo di collisioni di spazi dei nomi all'interno di una determinata cache. Il prefisso può avere due forme:
Chiave della cache anteposta nel modulo orgName__envName__applicationName__proxyNameITargetName Ad esempio, la stringa completa potrebbe avere il seguente aspetto: apifactory__test__weatherapi__default__apiAccessToken |
Note sull'utilizzo
Utilizza questo criterio per la memorizzazione nella cache per uso generico. In fase di runtime, la norma 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 una policy PopulateCache, la policy LookupCache deve avere elementi correlati alla chiave della cache configurati nello stesso modo della policy PopulateCache.
La memorizzazione nella cache per uso generico con i criteri PopulateCache,
LookupCache e InvalidateCache utilizza
una cache che configuri 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 la sezione Memorizzazione nella cache per uso generico. Per saperne di più sul datastore sottostante, consulta 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 al contenuto dei messaggi oppure al contesto disponibile nel flusso. Per ulteriori informazioni sulle variabili di flusso, consulta Riferimento alle 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.{policy-name}.cachename | Stringa | Sola lettura | Restituisce il nome della cache utilizzato nel criterio. |
lookupcache.{policy-name}.cachekey | Stringa | Sola lettura | Restituisce la chiave utilizzata. |
lookupcache.{policy-name}.cachehit | Booleano | Sola lettura | Vero se il criterio ha trovato un valore per la chiave della 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 impostate quando questo criterio attiva un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per un proxy. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.
Prefisso del codice di errore
N/D
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 dell'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. |
build |
InvalidTimeout |
Se l'elemento <CacheLookupTimeoutInSeconds> è impostato su
un numero negativo, il deployment del proxy API non va a buon fine. |
build |
CacheNotFound |
Questo errore si verifica se la cache specifica indicata nel messaggio di errore non è stata creata su un componente di elaborazione dei messaggi specifico. | build |
Variabili di errore
N/D
Esempio di risposta di errore
N/D