Чтобы переводить контент на ваш предпочитаемый язык, Google использует технологии на основе искусственного интеллекта. Переводы от ИИ могут содержать ошибки.

Справочник по конфигурации пакета общего процесса

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

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

Если вы только учитесь создавать общие процессы, начните с раздела Многократно используемые общие процессы.

Структура пакета общего потока

Пакет общего потока состоит из следующих элементов:

Базовая конфигурация	Основные настройки конфигурации. Подробнее о базовой конфигурации…
Правила	Файлы конфигурации в формате XML, соответствующие схемам правил Apigee Edge. Правила
Полезные ресурсы	Скрипты, JAR-файлы и XSLT-файлы, на которые ссылаются правила для выполнения пользовательской логики. Ресурсы
SharedFlows	Общие потоки, включенные в этот пакет. Подробнее о совместном использовании процессов…

Компоненты, перечисленные в таблице выше, определяются файлами конфигурации в следующей структуре каталогов:

Файлы конфигурации и структура каталогов пакета общего потока

В этом разделе описаны файлы конфигурации и структура каталогов пакета общего потока.

Базовая конфигурация
Правила
Общие процессы
Полезные ресурсы

Базовая конфигурация

Базовый файл конфигурации находится в корневом каталоге пакета. Его название совпадает с названием пакета.

/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 и minorVersion 0. Этот параметр может быть использован в будущем для развития формата пакета общего потока.	4.0	Нет
`CreatedAt` и `CreatedBy`	Дата и время (в формате epoch time), когда был создан пакет общего потока, а также адрес электронной почты пользователя, который его создал.
`Description`	Текстовое описание общего потока. Если описание указано, оно будет показываться в интерфейсе управления Edge.	Н/Д	Нет
`DisplayName`	Понятное название, которое может отличаться от атрибута `name` конфигурации общего потока.	Н/Д	Нет
`LastModifiedAt` и `LastModifiedBy`	Дата и время (в формате epoch time) последнего изменения пакета общего потока, а также адрес электронной почты пользователя, который внес изменения.
`Policies`	Список правил в каталоге `/policies` этого общего потока. Обычно этот элемент можно увидеть, только если общий поток был создан с помощью интерфейса управления Edge. Это просто настройка манифеста, предназначенная для того, чтобы сделать содержимое общего потока видимым.	Н/Д	Нет
`Resources`	Список ресурсов (JavaScript, Python, Java, XSLT) в каталоге `/resources` этого общего потока. Обычно этот элемент можно увидеть, только если общий поток был создан с помощью интерфейса управления Edge. Это просто настройка манифеста, которая позволяет видеть содержимое общего потока.	Н/Д	Нет
`SharedFlows`	Указывает общий поток, который содержит этот пакет. Обратите внимание, что в настоящее время этот элемент поддерживает только один дочерний элемент <SharedFlow>. В пакет общего потока можно добавить только один общий поток.	Н/Д	Да

Общие потоки

/sharedflowbundle/sharedflows/default.xml

Конфигурация SharedFlow определяет последовательность, в которой должны выполняться элементы потока. Каждый дочерний элемент <Step> элемента <SharedFlow> определяет часть последовательности, например вызов правила.

В приведенной ниже конфигурации SharedFlow указаны три правила, которые будут выполняться сверху вниз (слева направо в консоли управления). Первым будет выполнено правило защиты от пиковых нагрузок, а последним – правило вызова потока.

<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`	Указывает название объекта, на который ссылается шаг. Значение этого элемента должно совпадать с уникальным идентификатором объекта, например со значением атрибута name для правила.	Н/Д	Да

Правила

/sharedflowbundle/policies

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

Ресурсы

/sharedflowbundle/resources

Ресурсы – это скрипты, код и преобразования XSL, которые можно прикрепить к общим потокам с помощью правил. Они отображаются в разделе "Скрипты" редактора общего потока в интерфейсе управления.

Поддерживаемые типы ресурсов перечислены в разделе Файлы ресурсов.

Задавайте вопросы на форуме разработчиков Apigee.