Criterio SearchCache

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

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 Compila la cache (per la scrittura di voci) e il criterio Invalida cache (per le voci invalidate).

Per memorizzare le risposte delle risorse di backend nella cache, consulta il Criterio 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>

La cache condivisa è inclusa per impostazione predefinita. Per utilizzare la cache condivisa, ometti l'elemento <CacheResource> in questa configurazione del criterio.

Per saperne di più sull'archivio dati sottostante, consulta Elementi interni della cache. Per saperne di più sulla configurazione delle cache, consulta Creazione e modifica di una cache dell'ambiente.

Attributi <LookupCache>

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

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>

Elemento <AssignTo>

Specifica la variabile in cui viene assegnata la voce della cache dopo che è 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>

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>

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

Puoi utilizzare l'elemento <CacheKey> insieme a <Prefix> e <Scope>. Per ulteriori informazioni, consulta Utilizzo delle chiavi cache.

Elemento <CacheLookupTimeoutInsecondi>

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

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Elemento<CacheResource>

Specifica la cache in cui archiviare i messaggi.

Ometti completamente questo elemento se questo criterio (e i criteri PopulateCache e InvalidateCache corrispondenti) utilizzano la cache condivisa inclusa.

<CacheResource>cache_to_use</CacheResource>

Per saperne di più sulla configurazione delle cache, consulta Creazione e modifica di una cache di ambiente.

Elemento <CacheKey>/<KeyFragment>

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

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

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 (più il prefisso) vengono concatenati per creare la chiave cache.

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

Puoi utilizzare l'elemento <KeyFragment> insieme a <Prefix> e <Scope>. Per ulteriori informazioni, consulta Utilizzo delle chiavi cache.

Attributi

Elemento <CacheKey>/<Prefix>

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

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

Puoi utilizzare l'elemento <Prefix> insieme a <CacheKey> e <Scope>. Per ulteriori informazioni, consulta Utilizzo delle chiavi cache.

Elemento <Scope>

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

<Scope>scope_enumeration</Scope>

L'impostazione <Scope> determina una chiave cache da anteporre al valore <Scope>. Ad esempio, se l'ambito è impostato su Exclusive, una chiave cache assumerà il seguente formato: orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Se è presente un elemento <Prefix> in <CacheKey>, questo prevale sul valore dell'elemento <Scope>. I valori validi includono le enumerazioni riportate di seguito.

Puoi utilizzare l'elemento <Scope> insieme a <CacheKey> e <Prefix>. Per ulteriori informazioni, consulta Utilizzo delle chiavi cache.

Valori accettabili

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 assegnandolo 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 di cache configurati nello stesso modo del criterio PopulateCache.

La memorizzazione nella cache per uso generico con il criterio Popula 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 saperne di più sulla configurazione delle cache, consulta Creazione e modifica di una cache di ambiente. Per saperne di più sull'archivio dati sottostante, consulta Elementi 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 ulteriori informazioni sulle variabili di flusso, consulta la documentazione di riferimento sulle variabili.

Le seguenti variabili Flow predefinite sono disponibili dopo aver personalizzato il comportamento della cache definito in un criterio LookupCache.

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.

Variabili di errore

N/A

Esempio di risposta di errore

N/A