Эта страница переведена с помощью Cloud Translation API.

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

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

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

Совместные потоки

/sharedflowbundle/sharedflows/default.xml

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

Приведенная ниже конфигурация 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 .