Criterio LookupCache

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X.
Informazioni

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

Questo criterio è destinato all'uso nella memorizzazione nella cache a breve termine per uso generico. È utilizzata in in combinazione con il comando Compila Criterio della cache (per la scrittura delle voci) e Criterio della cache non valida (per l'annullamento della convalida delle voci).

Per memorizzare nella cache le risposte delle risorse di backend, consulta Criterio della cache delle risposte.

Riferimento elemento

Di seguito sono elencati gli elementi che puoi configurare su 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 il parametro <CacheResource> elemento in questa configurazione dei criteri.

Per scoprire di più sul datastore sottostante, consulta Informazioni interne della cache. Per scoprire di più sulla configurazione cache, consulta la sezione Creazione e modifica di un della cache di ambiente.

&lt;LookupCache&gt; attributi

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

&lt;AssignTo&gt; elemento

Specifica la variabile in cui la voce della cache viene assegnata dopo che è stata recuperata dalla . La variabile deve essere accessibile in scrittura. Se la ricerca cache non recupera un valore, la variabile non verrà impostato.

<AssignTo>variable_to_receive_cached_value</AssignTo>

Predefinita:

N/D

Presenza:

Obbligatorio

Tipo:

Stringa

&lt;CacheKey&gt; elemento

Configura un puntatore univoco a un dato archiviato nella cache.

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

Predefinita:

N/D

Presenza:

Obbligatorio

Tipo:

N/D

<CacheKey> genera il nome di ogni dato archiviato nell' .

In fase di runtime, i valori <KeyFragment> vengono anteposti al Valore dell'elemento <Scope> o valore <Prefix>. Ad esempio, la seguente determina la creazione di una chiave cache UserToken__apiAccessToken__&lt;value_of_client_id&gt;:

<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 ulteriori informazioni, vedi Utilizzo delle chiavi cache.

&lt;CacheLookupTimeoutInSeconds&gt; elemento

Specifica il numero di secondi dopo i quali una ricerca nella cache non riuscita viene considerata fallimento della cache. In questo caso, il flusso riprende lungo il percorso cache-miss.

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Predefinita:

30

Presenza:

Facoltativo

Tipo:

Numero intero

&lt;CacheResource&gt; elemento

Specifica la cache in cui devono essere archiviati i messaggi.

Ometti completamente questo elemento se questo criterio (e i valori corrispondenti I criteri InvalidateCache) stanno utilizzando la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Predefinita:

N/D

Presenza:

Facoltativo

Tipo:

Stringa

Per ulteriori informazioni sulla configurazione delle cache, consulta Creare e modificare un ambiente Cache.

&lt;CacheKey&gt;/&lt;KeyFragment&gt; elemento

Specifica un valore che deve essere incluso nella chiave cache, creando uno spazio dei nomi per la corrispondenza alle risposte memorizzate nella cache.

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

Predefinita:

N/D

Presenza:

Facoltativo

Tipo:

N/D

Può essere una chiave (un nome statico da te fornito) o un valore (una voce dinamica impostata mediante che fa riferimento a una variabile). Tutti i frammenti specificati combinati (più il prefisso) sono concatenati in per creare la chiave cache.

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

Utilizzi l'elemento <KeyFragment> in combinazione con <Prefix> e <Scope>. Per ulteriori informazioni, vedi Utilizzo delle chiavi cache.

Attributi

Attributo Tipo Predefinito Obbligatorio Descrizione
riferimento stringa No

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

&lt;CacheKey&gt;/&lt;Prefix&gt; elemento

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Predefinita:

N/D

Presenza:

Facoltativo

Tipo:

Stringa

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

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

&lt;Scope&gt; elemento

Enumerazione utilizzata per costruire un prefisso per una chiave cache quando <Prefix> non è fornito nell'elemento <CacheKey>.

<Scope>scope_enumeration</Scope>

Predefinita:

"Esclusiva"

Presenza:

Facoltativo

Tipo:

Stringa

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

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

Valori accettabili

Global

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

Se definisci una voce <CacheKey> con <KeyFragment> di apiAccessToken e di un ambito <Global>, ogni voce viene archiviata come orgName__envName__apiAccessToken, seguito dalla valore serializzato del token di accesso. Per un proxy API distribuito in un ambiente denominato 'test' in un'organizzazione chiamata "apifactory", i token di accesso venivano seguente chiave cache: apifactory__test__apiAccessToken.

Application

Il nome del proxy API viene utilizzato come prefisso.

La chiave della cache viene anteposta nel formato orgName__envName__applicationName.

Proxy

Come prefisso viene utilizzata la configurazione ProxyEndpoint.

La chiave della cache viene anteposta nel formato orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName di Google.

Target

Come prefisso viene utilizzata la configurazione TargetEndpoint.

Chiave cache anteposta nel modulo orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName di Google.

Exclusive

Predefinita. Si tratta della risposta più specifica e presenta quindi un rischio minimo di spazio dei nomi di conflitti all'interno di una determinata cache.

Il prefisso può essere di due tipi:

  • Se il criterio è collegato al flusso ProxyEndpoint, il prefisso è il nel formato ApiProxyName_ProxyEndpointName.
  • Se il criterio è allegato a TargetEndpoint, il prefisso è nel formato ApiProxyName_TargetName.

Chiave cache anteposta nel modulo orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

Ad esempio, la stringa completa potrebbe essere simile alla seguente:

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 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 cache chiave creata mediante una configurazione che combina gli elementi CacheKey e Scope. In altre parole, per recuperare un determinato valore aggiunto alla cache da un criterio DetailsCache, il comando LookupCache il criterio deve avere elementi relativi alle chiavi cache configurati allo stesso modo di ExampleCache .

Memorizzazione nella cache per uso generico con il criterio di inserimento della cache 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, è sufficiente omettere l'elemento <CacheResource>.

Per ulteriori informazioni sulla configurazione delle cache, consulta Creare e modificare un ambiente Cache. Per scoprire di più sul datastore sottostante, consulta Informazioni interne 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 sulle intestazioni HTTP o sui contenuti dei messaggi o sul contesto disponibile nel Flow. Per ulteriori informazioni sulle variabili di flusso, consulta Variabili riferimento.

Le seguenti variabili di flusso predefinite sono disponibili dopo aver personalizzato il comportamento delle che definisci 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 True se il criterio 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