Подключение и настройка политик в пользовательском интерфейсе

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

Добавление возможностей на основе политик к прокси-серверу API представляет собой двухэтапный процесс:

1. Настройте экземпляр типа политики.
2. Прикрепите экземпляр политики к потоку.

На диаграмме ниже показана взаимосвязь между политиками и потоками. Как видите, политика прикрепляется к потоку как «шаг» обработки. Чтобы настроить желаемое поведение вашего API, вам нужно немного разобраться в потоках. (Эта тема рассматривалась ранее в разделе «Настройка потоков» .)

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

Прикрепление политики к потоку

Чтобы прикрепить политику к потоку:

1. Выберите прокси-сервер API и перейдите к представлению «Разработка» .
2. В редакторе прокси-сервера API выберите поток, к которому вы хотите прикрепить политику, на панели «Навигатор».
   Например, поток PreFlow выбран для конечной точки прокси-сервера API по умолчанию на следующем рисунке:
   
3. В представлении «Дизайн» нажмите « +Шаг» , связанный с потоком запросов или ответов, чтобы прикрепить политику. Например:
   
   Откроется диалоговое окно «Добавить шаг», в котором отображается список политик по категориям.
   
4. Прокрутите и выберите тип политики, которую вы хотите прикрепить к выбранному потоку.
5. Измените следующие поля.

   • Отображаемое имя: уникальное отображаемое имя политики. Пользовательский интерфейс создаст имя по умолчанию, но рекомендуется создать для политики описательное имя. Это позволит другим разработчикам в вашей организации легко понять, для чего предназначена политика.

   • Имя : Уникальное имя политики. Имя политики совпадает с отображаемым именем, за следующими исключениями:

     • Пробелы заменяются тире.

     • Последовательные тире заменяются одним тире.

     • За исключением тире, подчеркивания и пробелов (которые заменяются, как отмечено выше), символы, не являющиеся буквенно-цифровыми, такие как знаки решетки, знаки процента, амперсанды и т. д., удаляются.

6. Нажмите Добавить.

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

После прикрепления политики вы увидите политику, отображаемую в представлении конструктора для потока, в этом примере PreFlow конечной точки прокси-сервера по умолчанию, а также в списке политик на панели навигации. Представление «Код» , в котором отображается XML для вновь подключенной политики, отображается под представлением «Дизайнер» . Edge создает экземпляр политики, содержащий набор разумных значений по умолчанию.

Добавление политики без присоединения ее к потоку

Чтобы добавить политику, не привязывая ее к потоку, что полезно для обработки ошибок , нажмите + на панели «Политики» в представлении «Навигатор» , чтобы открыть диалоговое окно «Добавить политику» и добавить политику (как описано в шагах 4–6 в предыдущем разделе). ).

Политика, которая не прикреплена ни к какому потоку, помечается значком «отсоединенный» в списке «Политики» , как показано рядом с политикой сообщений ключей API, показанной на предыдущем рисунке.

После создания политики вы можете прикрепить ее к потоку, перетащив ее из списка «Политики» в нужный поток в представлении «Дизайнер» .

Отключение политик от потока

Чтобы отсоединить политику от потока, выберите поток. Наведите указатель мыши на значок политики в представлении «Дизайнер потока». Нажмите X в кружке, который появляется на значке.

Удаление экземпляра политики

Чтобы удалить экземпляр политики, наведите указатель мыши на запись политики в представлении «Навигатор» . Нажмите X в круге, который появляется справа от записи.

Настройка политик в пользовательском интерфейсе

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Вы можете настроить политику, непосредственно отредактировав ее XML-конфигурацию в представлении «Код» . Например, пиковая скорость сообщений для политики Spike Arrest изначально установлена ​​на уровне 30 сообщений в секунду. Пиковую ставку можно изменить, изменив значение элемента Rate в XML-коде политики. Дополнительные сведения о настройке политик см. в справочнике по политикам .

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

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

Документацию по политике квот, используемой в этом разделе, см. в разделе Политика квот .