Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Общий поток — это функциональность многократного использования, аналогичная прокси-серверу API. Большая часть содержания этого справочника будет вам знакома, если вы уже знакомы с прокси-серверами API.
Если вы учитесь создавать общий поток, начните с темы «Многократно используемые общие потоки» .
Структура пакета общего потока
Пакет общего потока состоит из следующей конфигурации:
| Базовая конфигурация | Первичные настройки конфигурации. См. базовую конфигурацию. |
| Политика | Файлы конфигурации в формате XML, соответствующие схемам политики Apigee Edge. См. Политики . |
| Ресурсы | Скрипты, файлы JAR и файлы XSLT, на которые ссылаются политики для выполнения пользовательской логики. См. Ресурсы . |
| Общие потоки | Общие потоки включены в этот пакет. См. Общие потоки . |
Компоненты в таблице выше определяются файлами конфигурации в следующей структуре каталогов:
Файлы конфигурации и структура каталогов пакета общего потока
В этом разделе описываются файлы конфигурации и структура каталогов пакета общего потока.
Базовая конфигурация
Базовый файл конфигурации находится в корневом каталоге пакета. Его имя — это имя пакета.
/sharedflowbundle/traffic-management-shared.xml
Базовая конфигурация определяет содержимое пакета общего потока, а также информацию для отслеживания истории изменений пакета.
<SharedFlowBundle revision="2" name="traffic-management-shared">
<ConfigurationVersion majorVersion="4" minorVersion="0"/>
<CreatedAt>1478637529218</CreatedAt>
<CreatedBy>gladys@example.com</CreatedBy>
<Description>Shared flow to moderate API traffic</Description>
<DisplayName>traffic-management-shared</DisplayName>
<LastModifiedAt>1481573374023</LastModifiedAt>
<LastModifiedBy>gladys@example.com</LastModifiedBy>
<Policies>
<Policy>Auth-Flow-Callout</Policy>
<Policy>Extract-Token</Policy>
<Policy>Spike-Arrest</Policy>
</Policies>
<Resources>
<Resource>jsc://extract-token.js</Resource>
</Resources>
<SharedFlows>
<SharedFlow>default</SharedFlow>
</SharedFlows>
</SharedFlowBundle>
Базовые атрибуты конфигурации
| Имя | Описание | По умолчанию | Необходимый? |
|---|---|---|---|
SharedFlowBundle | |||
name | Имя пакета общего потока, которое должно быть уникальным в пределах организации. В имени разрешено использовать следующие символы: A-Za-z0-9_- | Н/Д | Да |
revision | Номер версии конфигурации пакета общего потока. Вам не нужно явно задавать номер версии, поскольку Apigee Edge автоматически отслеживает текущую версию общего потока. | Н/Д | Нет |
Элементы базовой конфигурации
| Имя | Описание | По умолчанию | Необходимый? |
|---|---|---|---|
SharedFlowBundle | |||
ConfigurationVersion | Версия схемы конфигурации пакета общего потока, которой соответствует этот общий поток. В настоящее время единственным поддерживаемым значением является majorVersion 4 и majorVersion 0. Этот параметр можно использовать в будущем, чтобы обеспечить развитие формата пакета общего потока. | 4.0 | Нет |
CreatedAt и CreatedBy | Дата/время (в эпохальном времени) создания пакета общего потока, а также адрес электронной почты пользователя, создавшего его. | ||
Description | Текстовое описание общего потока. Если оно предоставлено, описание будет отображаться в пользовательском интерфейсе управления Edge. | Н/Д | Нет |
DisplayName | Понятное имя, которое может отличаться от атрибута name конфигурации общего потока. | Н/Д | Нет |
LastModifiedAt и LastModifiedBy | Дата/время (в эпохальном времени) последнего изменения пакета общего потока, а также адрес электронной почты пользователя, который его изменил. | ||
Policies | Список политик в каталоге /policies этого общего потока. Обычно вы увидите этот элемент только в том случае, если общий поток был создан с помощью пользовательского интерфейса управления Edge. Это просто параметр «манифеста», предназначенный для обеспечения видимости содержимого общего потока. | Н/Д | Нет |
Resources | Список ресурсов (JavaScript, Python, Java, XSLT) в каталоге /resources этого общего потока. Обычно вы увидите этот элемент только в том случае, если общий поток был создан с помощью пользовательского интерфейса управления Edge. Это просто параметр «манифеста», предназначенный для обеспечения видимости содержимого общего потока. | Н/Д | Нет |
SharedFlows | Указывает общий поток, содержащийся в этом пакете. Обратите внимание, что в настоящее время этот элемент поддерживает только один дочерний элемент <SharedFlow>. В пакет общего потока можно добавить только один общий поток. | Н/Д | Да |
Общие потоки
/sharedflowbundle/sharedflows/default.xml
Конфигурация SharedFlow определяет последовательность, в которой должны выполняться элементы потока. Каждый дочерний элемент <Step> элемента <SharedFlow> определяет часть последовательности, например вызов политики.
Следующая конфигурация SharedFlow определяет три политики, которые должны выполняться в последовательности сверху вниз (слева направо в консоли управления), причем политика Spike Arrest первой и политика Flow Callout последней.
<SharedFlow name="default">
<Step>
<Name>Spike-Arrest</Name>
</Step>
<Step>
<Name>Extract-Token</Name>
</Step>
<Step>
<Name>Auth-Flow-Callout</Name>
</Step>
</SharedFlow>
Атрибуты конфигурации общего потока
| Имя | Описание | По умолчанию | Необходимый? |
|---|---|---|---|
SharedFlow | |||
name | Имя общего потока, которое должно быть уникальным в пределах организации. В имени разрешено использовать следующие символы: A-Za-z0-9_- | Н/Д | Да |
revision | Номер версии конфигурации общего потока. Вам не нужно явно задавать номер версии, поскольку Apigee Edge автоматически отслеживает текущую версию общего потока. | Н/Д | Нет |
Элементы конфигурации общего потока
| Имя | Описание | По умолчанию | Необходимый? |
|---|---|---|---|
SharedFlow | Определяет последовательность политик в общем потоке. | Н/Д | Да |
Step | Определяет шаг — этап в последовательности потока. | Н/Д | Да |
Name | Указывает имя элемента, на который ссылается шаг. Значение этого элемента должно совпадать с уникальным идентификатором элемента, например значением атрибута имени политики. | Н/Д | Да |
Политика
/sharedflowbundle/policies
Как и в прокси-сервере API, в пакете общего потока каталог /policies содержит XML-файл конфигурации для всех политик, доступных для присоединения к общему потоку в пакете. Политики совместно используют подмножество элементов, хотя это подмножество дополняется элементами, специфичными для данной политики. Дополнительные сведения о настройке политики см. в разделе о нужной политике. Вы также можете получить к ним доступ из Обзора ссылок на политику .
Ресурсы
/sharedflowbundle/resources
Ресурсы — это сценарии, код и преобразования XSL, которые можно прикрепить к общим потокам с помощью политик. Они отображаются в разделе «Сценарии» редактора общего потока в пользовательском интерфейсе управления.
См. файлы ресурсов для поддерживаемых типов ресурсов.
Задавайте вопросы на форуме разработчиков Apigee .