Правила LookupCache

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

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

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

Чтобы узнать, как кешировать ответы внутренних ресурсов, ознакомьтесь с правилами кеширования ответов.

Сведения об элементах

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

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

Общий кеш включен по умолчанию. Чтобы использовать общий кеш, удалите элемент <CacheResource> из конфигурации правила.

Подробнее о внутреннем хранилище данных… Подробнее о том, как создавать и редактировать кеш среды…

Атрибуты <LookupCache>

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

Элемент <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

Элемент <AssignTo>

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

<AssignTo>variable_to_receive_cached_value</AssignTo>

Элемент <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>. Подробнее о работе с ключами кеша…

Элемент <CacheLookupTimeoutInSeconds>

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

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Элемент <CacheResource>

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

Если это правило (и соответствующие правила PopulateCache и InvalidateCache) использует встроенный общий кеш, полностью удалите этот элемент.

<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>. Подробнее о работе с ключами кеша…

Элемент <Scope>

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

<Scope>scope_enumeration</Scope>

Настройка <Scope> определяет ключ кеша, который добавляется в начало в соответствии со значением <Scope>. Например, если область действия задана как Exclusive, ключ кеша будет иметь следующий вид:orgName__envName__applicationName__proxy|TargetName__[ serializedCacheKey ].

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

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

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

apifactory__test__weatherapi__16__default__apiAccessToken

Примечания

Используйте эти правила для кеширования общего назначения. Во время выполнения правило LookupCache извлекает значение из кеша и присваивает его переменной, указанной в элементе AssignTo (если значение не извлекается, переменная не задается). Оно ищет значение на основе ключа кеша, созданного с помощью конфигурации, которая объединяет элементы CacheKey и Scope. Другими словами, чтобы получить определенное значение, добавленное в кеш правилом PopulateCache, в правиле LookupCache должны быть настроены элементы, связанные с ключом кеша, так же, как в правиле PopulateCache.

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

Подробнее о том, как создавать и изменять кеш среды… Подробнее о внутреннем хранилище данных…

Переменные процесса

Переменные потока можно использовать для настройки динамического поведения политик и потоков во время выполнения на основе заголовков HTTP, содержимого сообщений или контекста, доступного в потоке. Подробнее о переменных потока…

После того как вы настроите поведение кеша, определенного в правиле LookupCache, станут доступны следующие предопределенные переменные потока:

Коды ошибок

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

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

Н/Д

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

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

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

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

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

Н/Д

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

Н/Д