Прикрепление и настройка политик в файлах XML

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

Вы можете создавать и редактировать политики локально, используя свой любимый текстовый редактор, редактор XML или IDE. В этом разделе в качестве примера того, как создавать, настраивать, прикреплять, развертывать и тестировать политики, используется тип политики «Квота».

Большинство API-прокси используют квоты. Квоты позволяют контролировать, как часто клиентскому приложению разрешено вызывать API в течение заданного временного интервала. В приведенном ниже примере политика квот настроена таким образом, чтобы ограничивать количество запросов до 1 в минуту. (Хотя это может быть нереалистично, это простой способ увидеть эффект от политики.)

В конфигурации API-прокси файлы политик хранятся в виде XML-файлов в каталоге /apiproxy/policies .

Например, политика типа «Квота» под названием «QuotaPolicy» может быть создана в виде файла QuotaPolicy.xml со следующим содержимым:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Вы можете создать текстовый файл вручную или сгенерировать политику на основе XML-схемы. Все политики имеют некоторые параметры, специфичные для данного типа политики, и некоторые параметры, общие для всех политик.

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

Все политики определяют следующие атрибуты:

  • enabled : Указывает, включена или выключена политика. Политики можно включать/отключать во время выполнения, изменяя этот параметр. Политика, для которой параметр enabled установлен в false не будет применяться.
  • continueOnError : Определяет, должен ли конвейер продолжать обработку сообщения, если политика не выполняется. При применении политик квот ошибки, скорее всего, указывают на превышение квоты, поэтому этот атрибут следует установить в значение false.
  • name : Имя, которое вы присваиваете этой политике. Это имя уникально для данного экземпляра политики и используется для прикрепления политики к потоку в качестве этапа обработки.

В приведенном выше примере элементы Allow , Interval и TimeUnit относятся к политике квот. Эти элементы предоставляют настройки, которые API Services применяют от имени API. Другие типы политик определяют свои собственные настройки, о которых можно узнать в Справочнике по политикам .