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

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

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

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

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

Например, политику типа Quota под названием «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 применяют от имени API. Другие типы политик определяют свои собственные настройки, о которых вы можете узнать в Справочнике политик .