Политика ResponseCache

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

Кэширует данные из бэкэнд-ресурса, уменьшая количество запросов к нему. Поскольку приложения отправляют запросы к одному и тому же URI, вы можете использовать эту политику для возврата кэшированных ответов вместо переадресации этих запросов на бэкэнд-сервер. Политика ResponseCache может повысить производительность вашего API за счет уменьшения задержки и сетевого трафика.

Наиболее полезным ResponseCache окажется в тех случаях, когда данные бэкэнда, используемые вашим API, обновляются лишь периодически. Например, представьте, что у вас есть API, который предоставляет данные прогноза погоды, обновляемые только каждые десять минут. Используя ResponseCache для возврата кэшированных ответов между обновлениями, вы можете уменьшить количество запросов к бэкэнду. Это также сокращает количество сетевых переходов.

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

Образцы

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

'http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778' -H "bypass-cache:true"

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <!-- Explicitly refresh the cached response -->
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

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

Ссылка на элемент описывает элементы и атрибуты политики.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" />
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSeconds ref="flow.variable.here">300</TimeoutInSeconds>
    </ExpirySettings>
    <CacheResource>cache_to_use</CacheResource>
    <CacheLookupTimeoutInSeconds/>
    <ExcludeErrorResponse/>
    <SkipCacheLookup/>
    <SkipCachePopulation/>
    <UseAcceptHeader/>
    <UseResponseCacheHeaders/>
</ResponseCache>

атрибуты <ResponseCache>

<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">

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

Элемент <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

элемент <CacheKey>

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

Размер ключей кэша ограничен 2 КБ.

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

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

Во время выполнения значения <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>

Указывает кэш, в котором должны храниться сообщения. Опустите этот элемент, чтобы использовать включенный общий кэш. Вам следует указать CacheResource по имени, если вы хотите иметь возможность административно очищать записи, содержащиеся в кэше. Подробнее об этом см. в разделе «Кэши» .

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

<ExcludeErrorResponse> элемент

В настоящее время по умолчанию эта политика кэширует HTTP-ответы со всеми возможными кодами состояния. Это означает, что кэшируются как успешные, так и ошибочные ответы. Например, ответы с кодами состояния 2xx и 3xx кэшируются по умолчанию.

Установите для этого элемента значение true , если вы не хотите кэшировать ответы целевого объекта с кодами состояния ошибок HTTP; если этот элемент имеет значение true, будут кэшироваться только ответы с кодами состояния от 200 до 205. Это единственные коды состояния HTTP, которые Edge считает кодами «успеха», и вы не можете изменить эту связь.

Обсуждение шаблонов кэширования ответов, в которых этот элемент полезен, см. в этом сообщении сообщества .

Примечание: В одной из будущих версий (дата выхода которой будет определена позже) значение по умолчанию для этого элемента изменится на true. Подробности см. в примечаниях к выпуску Apigee .

<ExcludeErrorResponse>true</ExcludeErrorResponse>

элемент <ExpirySettings>

Указывает, когда должна истечь дата окончания действия записи в кэше. Если параметр <TimeoutInSeconds> присутствует, он переопределяет параметры <TimeOfDay> и <ExpiryDate> .

<ExpirySettings>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
</ExpirySettings>

<ExpirySettings> /<ExpiryDate> элемент

Указывает дату, когда запись в кэше должна истечь. Используйте формат mm-dd-yyyy . Если этот элемент присутствует, его соседний элемент, <TimeoutInSeconds> , ​​переопределяет <ExpiryDate> .

<ExpirySettings>
    <ExpiryDate ref="{date_variable}">expiration_date</ExpiryDate>
</ExpirySettings>

Атрибуты

<ExpiryDate ref="" />

Элемент <ExpirySettings>/<TimeOfDay>

Время суток, когда срок действия записи в кэше должен истечь. Используйте формат hh:mm:ss . Если этот элемент присутствует, его соседний элемент <TimeoutInSeconds> переопределяет <TimeOfDay> .

Время суток указывается в формате HH:mm:ss, где HH обозначает час в 24-часовом формате. Например, 14:30:00 означает 14:30.

Что касается времени суток, то языковые настройки и часовой пояс по умолчанию будут меняться в зависимости от того, где выполняется код (что невозможно определить при настройке политики). Информацию о настройке языковых настроек см. в разделе «Создание и редактирование кэша среды» .

<ExpirySettings>
    <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

Атрибуты

элемент <ExpirySettings>/<TimeoutInSec>

Количество секунд, по истечении которых запись в кэше должна стать недействительной.