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:
Attributo | Descrizione | Predefinito | Presenza |
---|---|---|---|
name |
Il nome interno del criterio. Il valore dell'attributo Se vuoi, puoi utilizzare l'elemento |
N/D | Obbligatorio |
continueOnError |
Imposta il valore su Imposta su |
falso | Facoltativo |
enabled |
Imposta il valore su Imposta |
true | Facoltativo |
async |
Questo attributo è obsoleto. |
falso | Deprecato |
<DisplayName> 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 |
---|---|
Presenza | Facoltativo |
Tipo | Stringa |
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>
Valore predefinito: |
N/D |
Presenza: |
Obbligatorio |
Tipo: |
Stringa |
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>
Valore predefinito: |
N/D |
Presenza: |
Obbligatorio |
Tipo: |
N/D |
<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>
Valore predefinito: |
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 corrispondenti) utilizza la cache condivisa inclusa.
<CacheResource>cache_to_use</CacheResource>
Valore predefinito: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
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>
Valore predefinito: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
N/D |
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
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 della cache.
<Prefix>prefix_string</Prefix>
Valore predefinito: |
N/D |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
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>
Valore predefinito: |
"Esclusiva" |
Presenza: |
Facoltativo |
Tipo: |
Stringa |
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
Global |
La chiave della cache è condivisa tra tutti i proxy API di cui è stato eseguito il deployment nell'ambiente. La chiave della cache viene premessa 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 di ProxyEndpoint viene utilizzata come prefisso. La chiave della cache viene anteposta nel formato orgName__envName__applicationName__proxyEndpointName . |
Target |
La configurazione di TargetEndpoint viene utilizzata come prefisso. Chiave della cache anteposta nel formato orgName__envName__applicationName__targetEndpointName . |
Exclusive |
Predefinita. È il più specifico e, pertanto, presenta un rischio minimo di collisioni di spazi dei nomi all'interno di una determinata cache. Il prefisso può essere di due tipi:
Chiave della cache anteposta al modulo orgName__envName__applicationName__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 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.
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 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. |
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 menzionata nel messaggio di errore non è stata creata su un componente specifico dell'elaboratore di messaggi. | build |
Variabili di errore
N/A
Esempio di risposta di errore
N/A