Norme di PopulateCache

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

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

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>

<PopulateCache> attributi

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

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

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

<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__<value_of_client_id>:

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

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

<CacheKey>/<KeyFragment> 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>

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

<CacheKey>/<Prefix> elemento

Specifica un valore da utilizzare come prefisso della chiave cache.

<Prefix>prefix_string</Prefix>

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.

<ExpirySettings> elemento

Specifica quando deve scadere una voce della cache. Quando presente, <TimeoutInSeconds> override sia <TimeOfDay> che <ExpiryDate>.

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

Elementi secondari di <ExpirySettings>

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

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

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

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

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

apifactory__test__weatherapi__16__default__apiAccessToken

<Source> elemento

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

<Source>source_variable</Source>

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.

La memorizzazione nella cache per uso generico con i criteri RulesCache, il criterio LookupCache e il criterio 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 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.

Informazioni sulla crittografia della cache

Edge per cloud pubblico: la cache è criptata solo in PCI e abilitati per HIPAA le tue organizzazioni. La crittografia per queste organizzazioni viene configurata durante l'organizzazione per eseguire il provisioning.

Codici di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

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