Политика LookupCache

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

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

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

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

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

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

<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> . Дополнительную информацию см. в разделе Работа с ключами кэша .

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

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

<Scope>scope_enumeration</Scope>

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

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

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

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

apifactory__test__weatherapi__16__default__apiAccessToken

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

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

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

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

Переменные потока

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

Следующие предопределенные переменные потока доступны после настройки поведения кэша, определенного в политике LookupCache.

Коды ошибок

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

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

Н/Д

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

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

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

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

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

Н/Д

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

Н/Д