Compila criterio Cache

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

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. Viene utilizzato in combinazione con il criterio Cache di ricerca (per la lettura delle voci della cache) e con il Criterio Cache di ricerca (per l'annullamento della convalida delle voci).

Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta la pagina Tipi di criteri.

Per memorizzare nella cache le risposte delle risorse di backend, consulta i criteri della cache di risposta.

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>

Attributi <compilaCache>

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: Le regole di errore vengono attivate SOLO in stato di errore (informazioni su continueOnError) Gestione dei guasti all'interno del flusso di corrente	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

Elemento <CacheKey>

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/A
Presenza:	Obbligatorio
Tipo:	N/A

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

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

Elemento<CacheResource>

Specifica la cache in cui devono essere archiviati i messaggi.

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

<CacheResource>cache_to_use</CacheResource>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

Per saperne di più sulla configurazione delle cache, consulta Memorizzazione nella cache per uso generico.

Elemento <CacheKey>/<KeyFragment>

Specifica un valore che deve essere incluso nella chiave cache. Specifica una variabile di cui rimuovere il riferimento con l'attributo ref o con un valore fisso.

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

Predefinita:	N/A
Presenza:	zero o più
Tipo:	N/A

In fase di runtime, Apigee crea la chiave 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, consulta Utilizzo delle chiavi cache.

Attributi

Attributo	Tipo	Predefinita	Obbligatorio	Descrizione
riferimento	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 fisso da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

Predefinita:	N/A
Presenza:	Facoltativo
Tipo:	String

Un elemento <Prefix> sostituisce qualsiasi elemento <Scope>.

In fase di runtime, Apigee crea la chiave 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, consulta Utilizzo delle chiavi cache.

Elemento <ExpirySettings>

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/A
Presenza:	Obbligatorio
Tipo:	N/A

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, il criterio applicherà la durata (TTL) massima alla 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 l'ora in un formato a 24 ore, nel fuso orario UTC. Ad esempio, 14:30:00 implica 02:30 del pomeriggio. <ExpirySettings> <TimeOfDay ref="var-containing-time">expiry</TimeOfDay> </ExpirySettings> Note: Specifica gli orari nel fuso orario del fuso orario UTC (Coordinated Universal Time). Compila la notazione dell'ora della cache segue la notazione della data standard internazionale definita nello standard internazionale ISO 8601.

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 figlio, il criterio recupererà il valore di scadenza dalla variabile di contesto denominata. Se la variabile non viene definita, il criterio utilizza il valore di testo letterale dell'elemento figlio.

Elemento <Scope>

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

<Scope>scope_enumeration</Scope>

Predefinita:	"Esclusiva"
Presenza:	Facoltativo
Tipo:	String

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

orgName__envName__apiProxyName__deployedRevisionNumber__proxy|TargetName__ [ orgName__envName__apiProxyName__deployedRevisionNumber__proxy|TargetName__ ]

Se un elemento <Prefix> è presente in <CacheKey>, sostituisce un valore dell'elemento <Scope>. I valori validi includono le enumerazioni seguenti.

Utilizzi l'elemento <Scope> insieme a <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 della cache è anteposta nel formato orgName __ envName __. Se definisci una voce <CacheKey> con <KeyFragment> apiAccessToken e un ambito <Global>, ogni voce viene archiviata come orgName__envName__apiAccessToken, seguito dal valore serializzato del token di accesso. Per un proxy API di cui è stato eseguito il deployment in un ambiente denominato "test" in un'organizzazione denominata "apifactory", i token di accesso vengono archiviati nella 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 cache viene anteposta nel formato orgName__envName__apiProxyName__deployedRevisionNumber__proxyEndpointName .
Target	Come prefisso viene utilizzata la configurazione TargetEndpoint. Chiave cache anteposta nel formato orgName__envName__apiProxyName__deployedRevisionNumber__targetEndpointName .
Exclusive	Predefinita. Si tratta del tipo più specifico e, di conseguenza, presenta il rischio minimo di collisioni degli spazi dei nomi all'interno di una determinata cache. Il prefisso può essere di due tipi: Se il criterio è collegato al flusso ProxyEndpoint, il formato del prefisso è ApiProxyName_ProxyEndpointName. Se il criterio viene collegato a TargetEndpoint, il prefisso è nel formato ApiProxyName_TargetName. Chiave cache anteposta nel formato orgName__envName__apiProxyName__deployedRevisionNumber__proxyNameITargetName Ad esempio, la stringa completa potrebbe essere simile alla seguente: apifactory__test__weatherapi__16__default__apiAccessToken .

Elemento <Source>

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

<Source>source_variable</Source>

Predefinita:	N/A
Presenza:	Obbligatorio
Tipo:	String

Note:

• Gli oggetti JSON vengono archiviati esclusivamente nella cache in memoria (L1).
• Se intendi memorizzare questi oggetti nella cache in una cachca permanente (L2), ti consigliamo di serializzarli in formato stringa.
• Seguendo questa pratica, puoi utilizzare in modo efficace la cache L2 e massimizzare l'efficienza della memorizzazione nella cache.
• Per ulteriori informazioni, consulta la sezione Interni della cache.
  

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 nell'elemento <Source> nella cache specificata nell'elemento <CacheResource>. Puoi utilizzare gli elementi <CacheKey>, <Scope> e <Prefix> per specificare una chiave che puoi utilizzare dal criterio <LookupCache> per recuperare il valore. Utilizza l'elemento <ExpirySettings> per configurare la scadenza del valore memorizzato nella cache.

La memorizzazione nella cache per uso generico con il criterio PopulationCache, 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 questa cache, ometti semplicemente l'elemento <CacheResource>.

Limiti della cache: si applicano vari limiti di cache, tra cui le dimensioni di nomi e valori, il numero totale di cache, il numero di elementi in una cache e la scadenza.

Per scoprire di più sul datastore sottostante, consulta Informazioni interne della cache.

Informazioni sulla crittografia della cache

Apigee e Apigee hybrid (versione 1.4 e successive): i dati della cache e KVM 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.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correggi per informazioni dettagliate sulla risoluzione dei problemi.

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>