InvalidateCache-Richtlinie

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Richtliniensymbol

Konfiguriert, wie die im Cache gespeicherten Werte aus dem Cache gelöscht werden.

Diese Richtlinie ist für die Anwendung beim allgemeinen, kurzzeitigen Caching vorgesehen. Sie wird in Verbindung mit der PopulateCache-Richtlinie und der LookupCache-Richtlinie (für das Lesen von Cache-Einträgen) verwendet.

Informationen zum Caching der Antworten von Backend-Ressourcen finden Sie unter ResponseCache-Richtlinie.

Diese Richtlinie ist eine erweiterbare Richtlinie und die Verwendung dieser Richtlinie kann je nach Apigee-Lizenz Auswirkungen auf die Kosten oder die Nutzung haben. Informationen zu Richtlinientypen und Auswirkungen auf die Nutzung finden Sie unter Richtlinientypen.

Elementverweis

Im Folgenden sind die über diese Richtlinie konfigurierbaren Werte aufgeführt.

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

<InvalidateCache>-Attribute

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails. See also:

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

<CacheContext>/<APIProxyName>-Element

Gibt den Namen der Anwendung an, die den Cache-Eintrag hinzugefügt hat.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attribute

Attribut Beschreibung Standard Presence Typ
ref Variable mit dem Anwendungsnamen. – Optional String

<CacheContext>-Element

Gibt an, wie ein Cache-Schlüssel erstellt wird, wenn kein Prefix-Elementwert angegeben ist, oder um Cache-Einträge zu löschen, die von einem anderen API-Proxy hinzugefügt wurden.

<CacheContext>
  <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName>
  <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName>
  <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName>
</CacheContext>

Wird zum Erstellen des CacheKey verwendet. Werte für APIProxyName, ProxyName und TargetName sind obligatorisch, wenn ein CacheKey-Präfix, also ein benutzerdefiniertes Präfix, nicht verwendet wird, um Cache-Einträge zu löschen, die von einem anderen API-Proxy hinzugefügt wurden.

<CacheKey>-Element

Konfiguriert einen eindeutigen Zeiger auf ein im Cache gespeichertes Datenelement.

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

Standard:

–

Präsenz:

 Erforderlich

Typ:

–

<CacheKey> erstellt den Namen jedes Datenelements, das im Cache gespeichert ist.

Zur Laufzeit werden <KeyFragment>-Werte entweder dem <Scope>-Elementwert oder dem <Prefix>-Wert vorangestellt. Das folgende Beispiel führt zu einem Cacheschlüssel von UserToken__apiAccessToken__<value_of_client_id>:

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

Sie verwenden das <CacheKey>-Element zusammen mit <Prefix> und <Scope>. Weitere Informationen finden Sie unter Mit Cache-Schlüsseln arbeiten.

<CacheResource>-Element

Gibt den Cache an, in dem Nachrichten gespeichert werden sollen.

Lassen Sie dieses Element vollständig weg, wenn diese Richtlinie (und Ihre entsprechenden PopulateCache- und LookupCache-Richtlinien) den enthaltenen freigegebenen Cache verwenden.

<CacheResource>cache_to_use</CacheResource>

Standard:

–

Präsenz:

 Optional

Typ:

String

Weitere Informationen zum Konfigurieren von Caches finden Sie unter Allgemeines Caching.

<CacheKey>/<KeyFragment>-Element

Gibt einen Wert an, der im Cache-Schlüssel enthalten sein soll. Geben Sie eine Variable an, auf die nicht länger über das Attribut ref oder über einen festen Wert verwiesen werden soll.

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

Standard:

–

Präsenz:

 Optional

Typ:

–

Zur Laufzeit erstellt Apigee den Cache-Schlüssel, indem der vom <Scope>-Element oder <Prefix>-Element abgerufene Wert einer Verkettung der aufgelösten Werte jedes <KeyFragment>-Elements vorangestellt wird. Weitere Informationen finden Sie unter Mit Cache-Schlüsseln arbeiten.

Attribute

Attribut Beschreibung Standard Presence Typ
Ref Die Variable, aus der der Wert abgerufen wird. Sollte nicht verwendet werden, wenn dieses Element einen Literalwert enthält. – Optional String

<CacheKey>/<Prefix>-Element

Gibt den Wert an, der als Cache-Schlüsselpräfix verwendet werden soll.

<Prefix>prefix_string</Prefix>

Standard:

–

Präsenz:

 Optional

Typ:

String

Ein <Prefix>-Element überschreibt jedes <Scope>-Element.

Zur Laufzeit erstellt Apigee den Cache-Schlüssel, indem der vom <Scope>-Element oder <Prefix>-Element abgerufene Wert einer Verkettung der aufgelösten Werte jedes <KeyFragment>-Elements vorangestellt wird. Weitere Informationen finden Sie unter Mit Cache-Schlüsseln arbeiten.

<CacheContext>/<ProxyName>-Element

Gibt den Namen des Proxys an, für den die Daten im Cache gespeichert wurden.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Standard:

–

Präsenz:

 Optional

Typ:

String

Attribute

Attribut Beschreibung Standard Presence Typ
Ref Die Variable, aus der der Wert abgerufen wird. Sollte nicht verwendet werden, wenn dieses Element einen Literalwert enthält. – Optional String

<PurgeChildEntries>-Element

true, um Cache-Einträge dauerhaft zu löschen, die denselben <Prefix>-Wert haben, der für diese Richtlinie konfiguriert ist, auch wenn die PopulateCache-Richtlinien, die diese Elemente in den Cache geladen haben, auch verschiedene <KeyFragment>-Elemente verwendet haben.

Wenn Sie alle Cache-Einträge desselben Präfixwerts entwerten, können Sie mehrere zugehörige Einträge gleichzeitig dauerhaft löschen.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Standard:

false

Präsenz:

 Optional

Typ:

Boolesch

<Scope>-Element

Aufzählung, die zum Erstellen eines Präfixes für einen Cache-Schlüssel verwendet wird, wenn das Element <Prefix> nicht im Element <CacheKey> angegeben ist.

<Scope>scope_enumeration</Scope>

Standard:

"Exklusiv"

Präsenz:

 Optional

Typ:

String

Mit der Einstellung <Scope> wird ein Cache-Schlüssel festgelegt, dem gemäß des Werts <Scope> etwas vorangestellt wird. Ein Cache-Schlüssel hat beispielsweise folgende Form, wenn der Bereich auf Exclusive eingestellt ist:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Ist in <CacheKey> ein <Prefix>-Element vorhanden, hat dies vor einem <Scope>-Elementwert Vorrang. Gültige Werte für das <Scope>-Element werden unten angezeigt.

Weitere Informationen finden Sie unter Mit Cache-Schlüsseln arbeiten.

Zulässige Werte

Bereichswert Beschreibung
Global

Der Cache-Schlüssel wird für alle API-Proxys freigegeben, die in der Umgebung bereitgestellt werden. Der Cache-Schlüssel wird im Format orgName __ envName vorangestellt.

Wenn Sie einen <CacheKey>-Eintrag mit dem <KeyFragment>-apiAccessToken und dem Bereich <Global> definieren, wird jeder Eintrag als orgName__envName__apiAccessToken gespeichert, gefolgt vom serialisierten Wert des Zugriffstokens. Für einen API-Proxy, der in einer Umgebung mit dem Namen "Test" in einer Organisation namens "apifactory" bereitgestellt wird, werden Zugriffstoken unter folgendem Cache-Schlüssel gespeichert: apifactory__test__apiAccessToken.
Application

Der API-Proxyname wird als Präfix verwendet.

Der Cache-Schlüssel hat das Format orgName__envName__applicationName.
Proxy

Die ProxyEndpoint-Konfiguration wird als Präfix verwendet.

Dem Cache-Schlüssel wird orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName vorangestellt.
Target

Die TargetEndpoint-Konfiguration wird als Präfix verwendet.

Dem Cache-Schlüssel wird orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName vorangestellt.
Exclusive

Standard. Dies ist die spezifischste Zuordnung und bedingt daher ein minimales Risiko in Sachen Namespace-Konflikten in einem bestimmten Cache.

Das Präfix gibt es in zwei Formen:

  • Wenn die Richtlinie an den Ablauf ProxyEndpoint angehängt wird, hat das Präfix das Format ApiProxyName_ProxyEndpointName.
  • Wenn die Richtlinie unter TargetEndpoint angehängt wird, hat das Präfix das Format ApiProxyName_TargetName.

Dem Cache-Schlüssel wird orgName__envName__applicationName__deployedREvisionNumber__proxyNameITargetName vorangestellt

Der vollständige String kann so aussehen:

apifactory__test__weatherapi__16__default__apiAccessToken
.

<CacheContext>/<TargetName>-Element

Gibt den Namen des Zielendpunkts an, für den die Daten im Cache gespeichert wurden.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Standard:

–

Präsenz:

 Optional

Typ:

String

Attribute

Attribut Beschreibung Standard Presence Typ
Ref Die Variable, aus der der Wert abgerufen wird. Sollte nicht verwendet werden, wenn dieses Element einen Literalwert enthält. – Optional String

Verwendungshinweise

Das allgemeine Caching mit der PopulateCache-Richtlinie, der LookupCache-Richtlinie und der InvalidateCache-Richtlinie verwendet entweder einen von Ihnen konfigurierten Cache oder einen freigegebenen Cache, der standardmäßig berücksichtigt wird. In den meisten Fällen sollte der zugrunde liegende freigegebene Cache Ihren Anforderungen genügen. Um diesen Cache zu verwenden, lassen Sie einfach das Element <CacheResource> weg.

Weitere Informationen zum Konfigurieren von Caches finden Sie unter Allgemeines Caching. Weitere Informationen zum zugrunde liegenden Datenspeicher finden Sie unter Cache-Internals.

Fehlercodes

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

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

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

Error name Cause Fix
InvalidCacheResourceReference This error occurs if the <CacheResource> element in the InvalidateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
CacheNotFound This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component.

Fault variables

N/A

Example error response

N/A