Compila criterio Cache

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

icona norme

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

Il criterio Compila cache è progettato per scrivere voci in una cache per uso generico a breve termine. È utilizzato insieme alla funzionalità Lookup Criterio della cache (per la lettura delle voci della cache) e Annulla convalida criterio Cache (per voci non valide).

Questo criterio è una norma estendibile e il suo utilizzo potrebbe comportare costi o di utilizzo delle applicazioni, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni per l'utilizzo, consulta Tipi di criteri.

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.

<PopulateCache async="false" continueOnError="false" enabled="true" name="Populate-Cache-1">
    <DisplayName>Populate Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <TimeoutInSeconds>300</TimeoutInSeconds>
    </ExpirySettings>
    <Source>flowVar</Source>
</PopulateCache>

&lt;PopulateCache&gt; attributi

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:

 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

&lt;CacheKey&gt; elemento

Configura un puntatore univoco a un dato archiviato nella cache.

La dimensione delle chiavi cache è limitata a 2 kB.

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

<CacheResource> elemento

Specifica la cache in cui devono essere archiviati i messaggi.

Ometti completamente questo elemento se questo criterio (e le risorse LookupCache e 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 Memorizzazione nella cache per uso generico.

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

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:

 zero o più

Tipo:

N/D

In fase di runtime, Apigee crea la chiave cache anteponendo il valore ottenuto <Scope> o <Prefix> in un elemento concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per ulteriori informazioni, vedi Operazione in corso con chiavi cache.

Attributi

Attributo Tipo Predefinito Obbligatorio Descrizione
riferimento string 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 fisso 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 <Scope> o <Prefix> in un elemento concatenazione dei valori risolti di ciascuno degli elementi <KeyFragment>. Per ulteriori informazioni, vedi Operazione in corso con chiavi cache.

&lt;ExpirySettings&gt; elemento

Specifica quando deve scadere una voce della cache.

<ExpirySettings>
  <!-- use exactly one of the following child elements -->
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

Predefinita:

N/D

Presenza:

 Obbligatorio

Tipo:

N/D

Elementi secondari di <ExpirySettings>

Utilizza esattamente un elemento secondario. La tabella seguente fornisce una descrizione degli elementi secondari di <ExpirySettings>:

Elemento secondario Descrizione
<TimeoutInSeconds>

Il numero di secondi dopo il quale una voce della cache deve scadere. 

<ExpirySettings>
  <TimeoutInSeconds ref="var-containing-duration">expiry</TimeoutInSeconds>
</ExpirySettings>

Questo elemento sostituisce l'elemento TimeoutInSec, ora deprecato.
<ExpiryDate>

Specifica la data in cui una voce della cache deve scadere. Specifica una stringa nel formato mm-dd-yyyy.

<ExpirySettings>
  <ExpiryDate ref="var-containing-date">expiry</ExpiryDate>
</ExpirySettings>

Se la data specificata è nel passato, la norma applicherà la durata massima per la voce memorizzata nella cache. Questo periodo massimo è di 30 giorni.
<TimeOfDay>

Specifica l'ora del giorno in cui una voce della cache deve scadere. Specifica una stringa nel formato HH:mm:ss, dove HH rappresenta il ora in un formato a 24 ore, nel fuso orario UTC. Ad esempio, 14:30:00 implica 14:30 del pomeriggio.

<ExpirySettings>
  <TimeOfDay ref="var-containing-time">expiry</TimeOfDay>
</ExpirySettings>

Devi specificare solo uno dei possibili elementi secondari. Se specifichi più elementi, l'ordine di precedenza è:TimeoutInSeconds, ExpiryDate, TimeOfDay.

Con ciascuno degli elementi secondari di <ExpirySettings> precedenti, se specifichi l'attributo facoltativo ref nell'elemento secondario, il criterio recupera il valore di scadenza dalla variabile di contesto denominata. Se la variabile non è definita, Il criterio utilizza il valore di testo letterale dell'elemento figlio.

<Scope> 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__apiProxyName__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 cache è anteposta nel formato orgName__envName__apiProxyName.
Proxy

Come prefisso viene utilizzata la configurazione ProxyEndpoint.

La chiave della cache viene anteposta nel formato orgName__envName__apiProxyName__deployedRevisionNumber__proxyEndpointName .
Target

Come prefisso viene utilizzata la configurazione TargetEndpoint.

Chiave cache anteposta nel modulo orgName__envName__apiProxyName__deployedRevisionNumber__targetEndpointName .
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__apiProxyName__deployedRevisionNumber__proxyNameITargetName

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

apifactory__test__weatherapi__16__default__apiAccessToken
.

&lt;Source&gt; elemento

Specifica la variabile il cui valore deve essere scritto nella cache.

<Source>source_variable</Source>

Predefinita:

N/D

Presenza:

 Obbligatorio

Tipo:

Stringa

Note sull'utilizzo

Utilizza questo criterio per la memorizzazione nella cache per uso generico. In fase di runtime, Il criterio <PopulateCache> scrive i dati dalla variabile specificata nel <Source> elemento alla cache specificata in Elemento <CacheResource>. Puoi usare <CacheKey>, <Scope> e <Prefix> per specificare una chiave che che puoi utilizzare dal criterio <LookupCache> per recuperare il valore. Utilizza la Elemento <ExpirySettings> da configurare quando deve scadere il valore memorizzato nella cache.

Memorizzazione nella cache per uso generico con il criterio DetailsCache, Utilizza i criteri LookupCache e i criteri InvalidateCache 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 questa cache, ometti semplicemente Elemento <CacheResource>.

Limiti della cache: vari limiti della cache applicabili, come dimensioni nome e valore, numero totale di cache, numero di elementi contenuti in una cache e la scadenza.

Per ulteriori informazioni sul datastore sottostante, consulta Interni della cache.

Informazioni sulla crittografia della cache

Apigee e Apigee hybrid (versione 1.4 e successive): cache e KVM i dati sono sempre criptati.

Codici di errore

Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Codice di errore Stato HTTP Si verifica quando
policies.populatecache.EntryCannotBeCached 500 Una voce non può essere memorizzata nella cache. L'oggetto del messaggio che viene memorizzato nella cache non è un'istanza di una classe Serializable.

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> nel criterio PopulateCache è impostato su un nome che non esiste nell'ambiente in cui viene eseguito il deployment del proxy API.
CacheNotFound La cache specificata nell'elemento <CacheResource> non esiste.

Variabili di errore

Queste variabili vengono impostate quando questo criterio attiva un errore. Per maggiori informazioni, consulta la sezione Cosa devi sapere sugli errori relativi ai criteri.

Variabili Dove Esempio
fault.name="fault_name" fault_name è il nome dell'errore, come indicato nella tabella Errori di runtime riportata sopra. Il nome del guasto è l'ultima parte del codice di errore. fault.name = "EntryCannotBeCached"
populatecache.policy_name.failed policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. populatecache.POP-CACHE-1.failed = true

Esempio di risposta di errore

{
  "fault": {
    "faultstring": "[entry] can not be cached. Only serializable entries are cached.",
    "detail": {
      "errorcode": "steps.populatecache.EntryCannotBeCached"
    }
  }
}

Esempio di regola di errore

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>