Присоединение общего потока с помощью перехватчика потока

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

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

Поскольку код, прикрепленный к обработчику потока, находится вне контекста основной логики API-прокси, некоторые аспекты его поведения отличаются от поведения API-прокси. Учитывайте следующее:

• Для прикрепления общего потока к хуку потока необходимо иметь разрешение. Вы должны быть администратором организации.
• К каждому хуку потока можно прикрепить только один общий поток.
• Вы можете прикрепить один и тот же общий поток к нескольким хукам потока.
• Если в общем потоке, прикрепленном к обработчику потока, возникает ошибка или во время выполнения общего потока возникают ошибки, сообщение будет отклонено, и ошибка будет отправлена ​​обратно вызывающей стороне.
• Если сообщение отклоняется во время выполнения обработчика потока, подробности будут записаны в аналитику в контексте вызываемого прокси-сервера. Общий поток также может вызвать ошибку с пользовательским кодом и сообщением об ошибке.

В следующем видеоролике показано, как подключить общий поток к обработчику потока, а затем отследить его в классическом пользовательском интерфейсе Edge.

В следующем видеоролике показано, как подключить общий поток к хуку потока, а затем отследить его в пользовательском интерфейсе New Edge.

Общий поток, подключенный к прокси-серверу через обработчик потока, предоставляет отличное место для логики, обеспечивающей соблюдение общих требований политики безопасности. Например, представьте, что у вас есть одна команда, управляющая одним набором требований безопасности для нескольких команд, представляющих разные направления бизнеса (LOB). Каждая команда LOB может разрабатывать API в соответствии со своими собственными требованиями, не учитывая более широкие требования безопасности. Команда безопасности может реализовать эти требования безопасности в общем потоке, а затем подключить этот поток к среде Apigee Edge с помощью обработчика потока. Поскольку общий поток не является частью кода прокси-сервера, команда безопасности может изменять его по мере необходимости, не вмешиваясь в код LOB.

Общие потоки, подключенные через обработчики потоков, выполняются в этой позиции для каждого API-прокси, развернутого в среде обработчика прокси . По этой причине возможность использования обработчиков потоков доступна только администраторам организации Apigee Edge.

Более подробную информацию об общих потоках см. в разделе «Повторно используемые общие потоки» .

Прикрепление общего потока к хуку потока осуществляется с помощью консоли управления Apigee Edge. К хуку потока можно прикрепить не более одного общего потока в каждом из следующих мест:

• Предварительный обработчик потока (Pre-proxy Flow Hook) для логики, которую необходимо обеспечить ДО выполнения запроса к конечной точке прокси-сервера.

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

• Предварительный обработчик потока для логики, которую необходимо обеспечить ДО вызова целевого объекта.

  Например, можно реализовать логирование до того, как запрос достигнет бэкэнда. Также можно обеспечить посредничество, удалив определенные поля из запроса.

• Обработчик потока после получения целевого ответа для логики, которую необходимо реализовать ПОСЛЕ выполнения ответа от целевого объекта.

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

• Post-proxy Flow Hook — это обработчик логики, который необходимо выполнить ПОСЛЕ обработки запроса к прокси-серверу и непосредственно перед отправкой ответа клиенту.

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

Присоединение общего потока к крюку потока

Для того чтобы прикрепить общий поток к обработчику потока, необходимо быть администратором в организации, в которой находится этот общий поток.

1. Перейдите на страницу Flow Hooks, как описано ниже.

   Край

   Чтобы получить доступ к странице Flow Hooks с помощью пользовательского интерфейса Edge:

   1. Войдите на сайт apigee.com/edge .
   2. Выберите организацию, в которой находится ваш общий поток. См. раздел «Переключение между организациями» .

      Общий поток данных будет доступен для любых API-прокси и общих потоков данных, развернутых в среде этой организации. Он не будет доступен извне этой организации.

   3. В левой панели навигации выберите Администрирование > Среды > Перехватчики потоков .

   Классический Edge (частное облако)

   Чтобы получить доступ к странице Flow Hooks с помощью классического интерфейса Edge:

   1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
   2. Выберите организацию, в которой находится ваш общий поток. См. раздел «Переключение между организациями» .

      Общий поток данных будет доступен для любых API-прокси и общих потоков данных, развернутых в среде этой организации. Он не будет доступен извне этой организации.

   3. В верхней панели навигации выберите API > Конфигурация среды > Перехватчики потоков .
2. В списке обработчиков потока выберите тот обработчик, к которому вы хотите прикрепить общий поток, исходя из того, где вы хотите, чтобы этот общий поток выполнялся.

   Местоположение крюка для подачи воды	Описание
   Предварительный прокси-крюк потока	ДО выполнения прокси-сервера
   Предварительно целевой крюк потока	ДО выполнения целевой конечной точки
   Постцелевой крюк потока	ПОСЛЕ выполнения целевого ответа
   Постпрокси-крючок потока	ПОСЛЕ прокси-сервера и непосредственно ПЕРЕД отправкой ответа клиенту

3. Наведите курсор на элемент управления потоком в списке, чтобы отобразить столбец с действиями.
4. Нажмите .
5. В диалоговом окне «Общий поток» выберите общий поток, который хотите подключить, в раскрывающемся списке «Общий поток» .
6. Нажмите ОК .
7. При необходимости прикрепляйте общие потоки к другим обработчикам потоков.