Политика InvalidateCache

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Настраивает способ очистки кэшированных значений из кэша.

Эта политика предназначена для использования в краткосрочном кэшировании общего назначения. Он используется в сочетании с политикой заполнения кэша (для записи записей) и политикой кэша поиска (для чтения записей кэша).

Для кэширования ответов серверных ресурсов смотрите политику Response Cache .

Ссылка на элемент

Ниже перечислены элементы, которые можно настроить в этой политике.

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

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <CacheContext>/<APIProxyName>

Указывает имя приложения, которое добавило запись в кэш.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Атрибуты

Элемент <CacheContext>

Указывает, как создать ключ кэша, если значение элемента Prefix не указано, или очистить записи кэша, добавленные другим прокси-сервером API.

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

Используется для создания CacheKey. Значения APIProxyName, ProxyName и TargetName являются обязательными, если префикс CacheKey (то есть пользовательский префикс) не используется для очистки записей кэша, добавленных другим прокси-сервером API.

Элемент <CacheKey>

Настраивает уникальный указатель на фрагмент данных, хранящихся в кеше.

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

<CacheKey> создает имя каждого фрагмента данных, хранящихся в кэше.

Во время выполнения к значениям <KeyFragment> добавляется либо значение элемента <Scope> , либо значение <Prefix> . Например, следующее приводит к получению ключа кэша UserToken__apiAccessToken__ < value_of_client_id> :

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

Вы используете элемент <CacheKey> в сочетании с <Prefix> и <Scope> . Дополнительную информацию см. в разделе Работа с ключами кэша .

Элемент <CacheResource>

Указывает кеш, в котором должны храниться сообщения.

Полностью опустите этот элемент, если эта политика (и соответствующие политики PopulateCache и LookupCache) используют включенный общий кеш.

<CacheResource>cache_to_use</CacheResource>

Дополнительные сведения о настройке кэшей см. в разделе Создание и редактирование кэша среды .

Элемент <CacheKey>/<KeyFragment>

Указывает значение, которое должно быть включено в ключ кэша, создавая пространство имен для сопоставления запросов с кэшированными ответами.

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

Это может быть ключ (статическое имя, которое вы предоставляете) или значение (динамическая запись, заданная путем ссылки на переменную). Все указанные фрагменты (плюс префикс) объединяются для создания ключа кэша.

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

Вы используете элемент <KeyFragment> в сочетании с <Prefix> и <Scope> . Дополнительную информацию см. в разделе Работа с ключами кэша .

Атрибуты

Элемент <CacheKey>/<Prefix>

Указывает значение, которое будет использоваться в качестве префикса ключа кэша.

<Prefix>prefix_string</Prefix>

Используйте это значение вместо <Scope> если вы хотите указать собственное значение, а не значение, перечисляемое <Scope> . Если определено, <Prefix> добавляет значение ключа кэша к записям, записываемым в кэш. Значение элемента <Prefix> переопределяет значение элемента <Scope> .

Вы используете элемент <Prefix> в сочетании с <CacheKey> и <Scope> . Дополнительную информацию см. в разделе Работа с ключами кэша .

Элемент <CacheContext>/<ProxyName>

Указывает имя прокси-сервера, для которого кэшировались данные.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Атрибуты

Элемент <PurgeChildEntries>

true для очистки записей кэша, которые имеют общее значение, заданное элементом <KeyFragment> , настроенным для этой политики. Значения в других частях ключа кэша, например в элементах <Prefix> , не учитываются.

Обратите внимание, что элемент <KeyFragment> должен быть указан. Если это не так, установка true для <PurgeChildEntries> может привести к очистке всех записей в кэше.

Аннулирование всех записей кэша с одним и тем же значением фрагмента ключа может быть полезным способом одновременной очистки нескольких связанных записей.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Элемент <Область>

Перечисление, используемое для создания префикса для ключа кэша, когда элемент <Prefix> не указан в элементе <CacheKey> .

<Scope>scope_enumeration</Scope>

Параметр <Scope> определяет ключ кэша, который добавляется в начало в соответствии со значением <Scope> . Например, ключ кэша будет иметь следующую форму, если для области действия установлено Exclusive :

orgName__envName__ Имя приложения__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Если элемент <Prefix> присутствует в <CacheKey> , он заменяет значение элемента <Scope> . Допустимые значения включают перечисления ниже.

Вы используете элемент <Scope> в сочетании с <CacheKey> и <Prefix> . Дополнительную информацию см. в разделе Работа с ключами кэша .

Допустимые значения

apifactory__test__weatherapi__16__default__apiAccessToken

Элемент <CacheContext>/<TargetName>

Указывает имя целевой конечной точки, для которой кэшировались данные.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Атрибуты

Примечания по использованию

Кэширование общего назначения с помощью политики заполнения кэша , политики LookupCache и политики InvalidateCache использует либо настроенный вами кеш, либо общий кеш, включенный по умолчанию. В большинстве случаев базовый общий кэш должен соответствовать вашим потребностям. Чтобы использовать этот кеш, просто опустите элемент <CacheResource> .

Дополнительные сведения о настройке кэшей см. в разделе Создание и редактирование кэша среды . Дополнительные сведения о базовом хранилище данных см. в разделе Внутреннее устройство кэша .

Коды ошибок

В этом разделе описаны сообщения об ошибках и переменные потока, которые задаются, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила сбоев для прокси. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Префикс кода ошибки

Н/Д

Ошибки выполнения

Эта политика не вызывает никаких ошибок во время выполнения.

Ошибки развертывания

Эти ошибки могут возникнуть при развертывании прокси-сервера, содержащего эту политику.

Переменные неисправности

Н/Д

Пример ответа об ошибке

Н/Д