Получение значения из кэша

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

Используйте политику cache-lookup-value, чтобы выполнять поиск в кэше по ключу и возвращать кэшированное значение. Ключ может содержать произвольное строковое значение и обычно указывается с помощью выражения политики.

Примечание.

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

Внимание

Встроенный кэш является непостоянным и совместно используется всеми единицами одного региона в той же службе Управления API.

Примечание.

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

Правило политики

<cache-lookup-value key="cache key value"
    default-value="value to use if cache lookup resulted in a miss"
    variable-name="name of a variable looked up value is assigned to"
    caching-type="prefer-external | external | internal" />

Атрибуты

Атрибут Описание Обязательное поле По умолчанию.
тип кэширования Выберите одно из следующих значений атрибута:
- internalдля использования встроенного кэша Управление API,
- external для использования внешнего кэша, как описано в разделе "Использование внешнего кэша, совместимого с Redis" в службе управления API Azure,
- prefer-external — использование внешнего кэша, если он настроен. В противном случае используется внутренний кэш.

Выражения политики не допускаются.
нет prefer-external
значение по умолчанию Значение, которое присваивается переменной, если поиск в кэше по ключу не дал результатов. Если этот атрибут не указан, присваивается значение null. Допустимы выражения политики. нет null
ключ Значение ключа кэша, которое нужно использовать при поиске. Допустимы выражения политики. Да Н/П
имя-переменной Имя переменной контекста, которой присваивается найденное значение, если поиск завершится успешно. Если поиск не дал результатов, переменная не будет задана. Выражения политики не допускаются. Да Н/П

Использование

Заметки об использовании

  • Управление API кэширует только ответы на HTTP-запросы GET.
  • Эту политику можно использовать только один раз в разделе политики.
  • Эта политика не поддерживается внутри фрагмента политики.
  • Мы рекомендуем настроить политику ограничения скорости (или политику ограничения скорости по ключу ) сразу после поиска кэша. Это помогает сохранить серверную службу от перегрузки, если кэш недоступен.

Пример

В этом примере показано, как использовать cache-lookup-value политику для получения профиля пользователя из кэша. Ключ для поиска кэша создается с помощью выражения политики, которое объединяет строку со значением переменной контекста enduserid .

Примечание.

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

См. пример кэш-хранилища значений для хранения профиля пользователя в кэше.

<cache-lookup-value
    key="@("userprofile-" + context.Variables["enduserid"])"
    variable-name="userprofile" />
<rate-limit calls="10" renewal-period="60" />

Дополнительные сведения и примеры этой политики см. в статье Custom caching in Azure API Management (Пользовательское кэширование в службе управления API Azure).

Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.