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

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

В этом разделе приведена справочная информация об элементах XML, которые используются для определения потоков прокси-сервера API.

Иерархия и синтаксис

В примерах ниже показана иерархия элементов и синтаксис элементов конфигурации потока:

Иерархия элементов

В примере ниже показана иерархия элементов конфигурации потока в элементах <ProxyEndpoint> и <TargetEndpoint>:

<ProxyEndpoint | TargetEndpoint>
    <PreFlow>
          <Request>
                <Step>
                    <Condition>
                    <Name>
          <Response>
                <Step>
                    <Condition>
                    <Name>
          <Description>
    <Flows>
          <Flow>
                <Description>
                <Condition>
                <Request>
                      <Step>
                          
                <Response>
                      <Step>
                          
          <Description>
    <PostFlow>
          <Request>
                <Step>
                    
          <Response>
                <Step>
                    
          <Description>
    <PostClientFlow> (<ProxyEndpoint> only)
          <Response>
                
          <Description>

      // Additional configuration elements

</ProxyEndpoint | TargetEndpoint>

Синтаксис

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

<!-- ProxyEndpoint flow configuration file -->
<ProxyEndpoint ... >
  ...
  <PreFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PreFlow>
  <Flows name="flow_name">
    <Flow name="conditional_flow_name">
      <Description>flow_description</Description>
      <Condition>property operator "value"</Condition>
      <Request>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Request>
      <Response>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Response>
    </Flow>
  </Flows>
  <PostFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostFlow>
  <PostClientFlow name="flow_name">
    <Description>flow_description</Description>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

<!-- TargetEndpoint flow configuration file -->
<TargetEndpoint ... >
  ...
  <PreFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PreFlow>
  <Flows name="flow_name">
    <Flow name="conditional_flow_name">
      <Description>flow_description</Description>
      <Condition>property operator "value"</Condition>
      <Request>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Request>
      <Response>
        <Step>
          <Condition>property operator "value"</Condition>
          <Name>policy_name</Name>
        </Step>
        ...
      </Response>
    </Flow>
    ...
  </Flows>
  <PostFlow name="flow_name">
    <Description>flow_description</Description>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </PostFlow>
  ...
</TargetEndpoint>

Эти элементы используются для определения выполнения PreFlow, Conditional Flow, PostFlow и PostClientFlow.

<Condition>

Определяет оператор, который обрабатывается во время выполнения. Если утверждение истинно, выполняется шаг или поток, связанный с условием. Если утверждение оценивается как ложное, шаг или поток игнорируется.

Тип Строка
Родительские элементы <Flow>
<Step>
Дочерние элементы Нет

Вы можете применить условие к определенному шагу или ко всему процессу в зависимости от того, в какой элемент вы поместите элемент: <Flow> или <Step>.

// Condition can apply to just one step:        // Or to the flow:
<Flows>                                         <Flows>
  <Flow>                                          <Flow>
    <Step>                                          <Condition>
      <Condition>                                   <Step>
      <Name>                                          <Name>
      ...                                             ...
    ...                                             ...
  ...                                             ...
</Flows>                                        </Flows>

Если условие в элементе <Step> истинно, Edge выполняет этот шаг. Если условие не выполняется, Edge пропускает шаг.

Если условие в <Flow> истинно, Edge обрабатывает все шаги в потоке. Если условие ложно, Edge пропускает весь поток.

Синтаксис

Элемент <Condition> имеет следующий синтаксис:

<Condition>property operator "value"</Condition>

Где:

property
Свойство переменной потока, которое вы хотите использовать в условии. Например, у переменной потока request есть свойства path и content. Чтобы использовать их в условии, укажите flow_variable[dot]property_name:
request.path
request.content

Полный список переменных потока и их свойств приведен в справочнике по переменным потока.

operator
Конструкция, определяющая, как оценивается условие. Распространенные операторы:
>     greater than           <=    less than or equal to
<     less than              >=    greater than or equal to
=     equals                 &&    and
!=    not equals             ||    or

~~    JavaRegex
~     Matches
/~    MatchesPath

Полный список операторов приведен в разделе Операторы справочной статьи об условиях.

"value"
Значение, с которым сравнивается свойство переменной потока. Обычно это базовый тип, например целое число или строка. Пример: 200 или "/cat". Значение может содержать подстановочные символы, например звездочки и другие символы для сопоставления с шаблоном, как описано в разделе Сопоставление с шаблоном с использованием условных операторов.

Пример 1

В следующем примере проверяется, имеет ли свойство verb переменной потока request значение GET:

<!-- api-platform/reference/examples/flow-segments/condition-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PreFlow>
  ...
</ProxyEndpoint>

Если запрос – GET, то в этом примере выполняется правило Log-Request-OK.

Пример 2

В следующем примере проверяется код ответа:

<!-- api-platform/reference/examples/flow-segments/condition-2.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Response>
      <Step>
        <Condition>response.status.code LesserThanOrEquals 300</Condition>
        <Name>Log-Response-OK</Name>
      </Step>
      <Step>
        <Condition>response.status.code GreaterThan 300</Condition>
        <Name>Log-Response-NOT-OK</Name>
      </Step>
    </Response>
  </PreFlow>
  ...
</ProxyEndpoint>

В зависимости от значения кода выполняется определенная политика.

Атрибуты

У элемента <Condition> нет атрибутов.

Дочерние элементы

У элемента <Condition> нет дочерних элементов.

<Description>

Описывает поток в удобном для восприятия формате. Используйте этот элемент, чтобы предоставить информацию о потоке себе или другим разработчикам. Описание не показывается внешним пользователям.

Тип Строка
Родительские элементы <Flow>
<PreFlow>
<PostFlow>
Дочерние элементы Нет

Синтаксис

Элемент <Description> имеет следующий синтаксис:

<Description>flow_description</Description>

Пример

В примере ниже показан элемент <Description>, в котором указано назначение потока:

<!-- api-platform/reference/examples/flow-segments/description-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Атрибуты

У элемента <Description> нет атрибутов.

Дочерние элементы

У элемента <Description> нет дочерних элементов.

<Flow>

Определяет набор шагов, которые выполняет Edge.

Тип Сложный объект
Родительские элементы <Flows>
Дочерние элементы <Condition>
<Description>
<Request>
<Response>

Вы можете указать <Condition> для <Flow>. В этом случае Edge выполняет шаги в потоке, только если условие истинно. В противном случае Edge пропустит весь процесс.

Элемент <Flows> может содержать несколько элементов <Flow>, каждый из которых имеет собственное условие и шаги. Если элементов <Flow> несколько, Edge выполняет только первый из них, в котором нет условия или условие имеет значение true.

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

Синтаксис

Элемент <Flow> имеет следующий синтаксис:

<Flow name="conditional_flow_name">
  <Description>flow_description</Description>
  <Condition>property operator "value"</Condition>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</Flow>

Все дочерние элементы <Flow> являются необязательными.

Пример 1

В следующем примере показан простой код <Flow>, который всегда выполняет правило "Log-Message-OK":

<!-- api-platform/reference/examples/flow-segments/flow-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-flow">
    <Flow>
      <Request>
        <Step>
          <Name>Log-Message-OK</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Пример 2

В следующем примере показан <Flow> с несколькими шагами, каждый из которых имеет собственное условие:

<!-- api-platform/reference/examples/flow-segments/flow-2.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Пример 3

В примере ниже показано несколько потоков в условном потоке:

<!-- api-platform/reference/examples/flow-segments/flows-2.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-2">
      <Response>
        <Step>
          <Condition>response.status.code >= 400</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-3">
      <Response>
        <Step>
          <Condition>response.status.code >= 300</Condition>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Edge выполняет только один поток в сегменте – первый поток, у которого нет условия или условие которого имеет значение true.

Атрибуты

В таблице ниже описаны атрибуты элемента <Flow>.

Атрибут Тип Описание
name Строка (Обязательно.) Уникальный идентификатор потока. Пример: "My-Conditional-Flow-1". Название не может содержать пробелы и специальные символы.

Дочерние элементы

В таблице ниже описаны дочерние элементы <Flow>.

Дочерний элемент Тип Описание
<Condition> Строка Определяет условное выражение, которое обрабатывается во время выполнения. Если условие истинно, выполняется поток и все его шаги. Если утверждение ложно, поток (и все его шаги) игнорируются.
<Description> Строка Краткое описание потока. Это описание не будет видно другим пользователям.
<Request> Сложный объект Указывает шаги и условия для сегмента запроса.
<Response> Сложный объект Указывает шаги и условия для сегмента ответа.

<Flows>

Содержит ноль или более элементов <Flow>.

Тип Сложный объект
Родительские элементы <ProxyEndpoint>
<TargetEndpoint>
Дочерние элементы <Flow>

Если в элементе <Flows> несколько элементов <Flow>, будет выполнен только один <Flow> из них. Это будет первый поток, в котором нет <Condition> или условие которого имеет значение true.

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

Синтаксис

Элемент <Flows> имеет следующий синтаксис:

<Flows name="flow_name">
  <Flow name="conditional_flow_name">
    <Description>flow_description</Description>
    <Condition>property operator "value"</Condition>
    <Request>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Request>
    <Response>
      <Step>
        <Condition>property operator "value"</Condition>
        <Name>policy_name</Name>
      </Step>
      ...
    </Response>
  </Flow>
</Flows>

Все дочерние элементы <Flows> являются необязательными.

Пример 1

Ниже показан простой элемент <Flows> с одним элементом <Flow>:

<!-- api-platform/reference/examples/flow-segments/flows-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Edge выполняет одно из этих правил на основе суффикса пути, полученного из переменной потока proxy. Если суффикс пути не соответствует ни одному из условий, Edge не выполняет этот поток.

Пример 2

В следующем примере показано несколько элементов <Flow> в элементе <Flows>, каждый из которых имеет собственный элемент <Condition>:

<!-- api-platform/reference/examples/flow-segments/flows-2.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-2">
      <Response>
        <Step>
          <Condition>response.status.code >= 400</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-flow-3">
      <Response>
        <Step>
          <Condition>response.status.code >= 300</Condition>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Edge выполняет только первый процесс в сегменте, условие которого имеет значение true. После этого Edge пропускает оставшиеся потоки в сегменте.

Пример 3

В следующем примере показан параметр <Flow> со значением "default":

<!-- api-platform/reference/examples/flow-segments/flows-3.xml -->
<ProxyEndpoint name="default">
  <Flows>
    <Flow name="my-conditional-flow-1">
      <Response>
        <Step>
          <Condition>response.status.code = 200</Condition>
          <Name>Assign-Message-1</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-conditional-flow-2">
      <Response>
        <Step>
          <Condition>response.header.someheader = "42"</Condition>
          <Name>Assign-Message-2</Name>
        </Step>
      </Response>
    </Flow>
    <Flow name="my-default-flow">
      <Response>
        <Step>
          <Name>Assign-Message-3</Name>
        </Step>
      </Response>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

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

Стандартный поток может быть полезным инструментом для защиты от вредоносных атак.

Атрибуты

У элемента <Flows> нет атрибутов.

Дочерние элементы

У элемента <Flows> есть следующие дочерние элементы:

Дочерний элемент Тип Описание
<Flow> Сложный объект Процесс, определяющий один из возможных наборов шагов в условном процессе.

<Name>

Идентификатор правил, которые нужно выполнить в <Flow>.

Тип Строка
Родительские элементы <Step>
Дочерние элементы Нет

Синтаксис

Элемент <Name> имеет следующий синтаксис:

<Name>policy_name</Name>

Пример

В следующем примере показаны два правила, добавленные в потоки по названию:

<!-- api-platform/reference/examples/flow-segments/name-1.xml -->
<ProxyEndpoint name="default">
  <Flows name="my-conditional-flows">
    <Flow name="reports">
      <Request>
        <Description>Based on the path suffix, determine which flow to use</Description>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/reports"</Condition>
          <Name>XML-to-JSON-1</Name>
        </Step>
        <Step>
          <Condition>proxy.pathsuffix MatchesPath "/forecasts"</Condition>
          <Name>Verify-Auth-1</Name>
        </Step>
      </Request>
    </Flow>
  </Flows>
  ...
</ProxyEndpoint>

Атрибуты

У элемента <Name> нет атрибутов.

Дочерние элементы

У элемента <Name> нет дочерних элементов.

<PostFlow>

Определяет шаги, которые нужно выполнить в PostFlow запроса и ответа.

Тип Сложный объект
Родительские элементы <ProxyEndpoint>
<TargetEndpoint>
Дочерние элементы <Description>
<Request>
<Response>

Элемент <PostFlow> имеет следующий синтаксис:

Синтаксис

<PostFlow name="flow_name">
  <Description>flow_description</Description>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PostFlow>

Пример

В примере ниже показан PostFlow с определенными шагами для запроса и ответа:

<!-- api-platform/reference/examples/flow-segments/postflow-1.xml -->
<ProxyEndpoint name="default">
  <PostFlow name="my-postflows">
    <Description>My first PostFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
    <Response>
      <Step>
        <Name>Set-Response-Headers</Name>
      </Step>
    </Response>
  </PostFlow>
  ...
</ProxyEndpoint>

Атрибуты

В таблице ниже описаны атрибуты элемента <PostFlow>.

Атрибут Тип Описание
name Строка Уникальный идентификатор потока (в пределах конечной точки). Пример: My-PostFlow-1. Значение не может содержать пробелы и другие специальные символы.

Дочерние элементы

В таблице ниже описаны дочерние элементы <PostFlow>.

Дочерний элемент Тип Описание
<Description> Строка Краткое описание потока.
<Request> Сложный объект Определяет правила, которые будут выполняться во время PostFlow запроса.
<Response> Сложный объект Определяет правила, которые будут выполняться во время PostFlow ответа.

<PostClientFlow>

Определяет правила в ProxyEndpoint, которые выполняются только после того, как ответ был возвращен клиенту. Эти правила обычно регистрируют сообщения, связанные с ответом.

Тип Сложный объект
Родительские элементы <ProxyEndpoint>
Дочерние элементы <Description>
<Response>

Синтаксис

Элемент <PostClientFlow> имеет следующий синтаксис:

<PostClientFlow name="flow_name">
  <Description>flow_description</Description>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PostClientFlow>

Все дочерние элементы <PostClientFlow> являются необязательными.

Пример

В примере ниже показан простой поток PostClientFlow, который выполняет одно правило.

<!-- api-platform/reference/examples/flow-segments/postclientflow-1.xml -->
<ProxyEndpoint name="default">
  <PostClientFlow name="my-postclientflows">
    <Description>My first PostClientFlow. Processed after the response is sent back to the client.</Description>
    <Response>
      <Step>
        <Name>Message-Logging-OK</Name>
      </Step>
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

Атрибуты

В таблице ниже описаны атрибуты элемента <PostClientFlow>.

Атрибут Тип Описание
name Строка Уникальный идентификатор потока. Название не может содержать пробелы и специальные символы. Пример: "My-PostClientFlow-1".

Дочерние элементы

В таблице ниже описаны дочерние элементы <PostClientFlow>.

Дочерний элемент Тип Описание
<Description> Строка Краткое описание потока.
<Response> Сложный объект Определяет правила, которые будут выполняться во время PostFlow ответа.

<PreFlow>

Определяет правила, которые будут выполняться в PreFlow запроса и ответа.

Тип Сложный объект
Родительские элементы <ProxyEndpoint>
<TargetEndpoint>
Дочерние элементы <Description>
<Request>
<Response>

Синтаксис

Элемент <PreFlow> имеет следующий синтаксис:

<PreFlow name="flow_name">
  <Description>flow_description</Description>
  <Request>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Request>
  <Response>
    <Step>
      <Condition>property operator "value"</Condition>
      <Name>policy_name</Name>
    </Step>
    ...
  </Response>
</PreFlow>

Все дочерние элементы <PreFlow> являются необязательными.

Пример

В следующем примере показан PreFlow с определенными потоками запроса и ответа:

<!-- api-platform/reference/examples/flow-segments/preflow-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
    <Response>
      <Step>
        <Condition>response.status.code LesserThanOrEquals 300</Condition>
        <Name>Log-Response-OK</Name>
      </Step>
      <Step>
        <Condition>response.status.code GreaterThan 300</Condition>
        <Name>Log-Response-NOT-OK</Name>
      </Step>
    </Response>
  </PreFlow>
  ...
</ProxyEndpoint>

Атрибуты

В таблице ниже описаны атрибуты элемента <PreFlow>.

Атрибут Тип Описание
name Строка Уникальный идентификатор потока. Название не может содержать пробелы и специальные символы. Пример: My-PreFlow-1.

Дочерние элементы

В таблице ниже описаны дочерние элементы <PreFlow>.

Дочерний элемент Тип Описание
<Description> Строка Краткое описание потока.
<Request> Сложный объект Определяет правила, которые будут выполняться во время PreFlow запроса.
<Response> Сложный объект Определяет правила, которые будут выполняться во время PreFlow ответа.

<Request>

Определяет правила, которые будут выполняться во время сегмента запроса в потоке.

Тип Сложный объект
Родительские элементы <Flow>
<PreFlow>
<PostFlow>
Дочерние элементы <Condition>
<Step>

Синтаксис

Элемент <Request> имеет следующий синтаксис:

<Request>
  <Step>
    <Condition>property operator "value"</Condition>
    <Name>policy_name</Name>
  </Step>
  ...
</Request>

Все дочерние элементы <Request> являются необязательными.

Пример

В следующем примере показаны потоки, определенные для запроса в PreFlow и PostFlow:

<!-- api-platform/reference/examples/flow-segments/request-1.xml -->
<ProxyEndpoint name="default">
  <PreFlow name="my-preFlows">
    <Description>My first PreFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PreFlow>
  <PostFlow name="my-postflows">
    <Description>My first PostFlow</Description>
    <Request>
      <Step>
        <Condition>request.verb = "GET"</Condition>
        <Name>Log-Request-OK</Name>
      </Step>
    </Request>
  </PostFlow>
  ...
</ProxyEndpoint>

Атрибуты

У элемента <Request> нет атрибутов.

Дочерние элементы

В таблице ниже описаны дочерние элементы <Request>.

Дочерний элемент Тип Описание
<Condition> Сложный объект Определяет, выполняются ли шаги в сегменте запроса.
<Step> Строка Указывает правило, которое нужно выполнить в сегменте запроса.

<Response>

Определяет правила, которые будут выполняться во время сегмента ответа потока.

Тип Сложный объект
Родительские элементы <Flow>
<PreFlow>
<PostClientFlow>
<PostFlow>
Дочерние элементы <Condition>
<Step>

Синтаксис

Элемент <Response> имеет следующий синтаксис:

<Response>
  <Step>
    <Condition>property operator "value"</Condition>
    <Name>policy_name</Name>
  </Step>
  ...
</Response>

Все дочерние элементы <Response> являются необязательными.

Пример

В следующем примере показаны потоки, определенные для ответа, как в PreFlow, так и в PostFlow:

<!-- api-platform/reference/examples/flow-segments/response-1.xml -->
<ProxyEndpoint name="default">
    <PreFlow name="my-preFlows">
        <Description>My first PreFlow</Description>
        <Response>
            <Step>
                <Condition>response.status.code LesserThanOrEquals 300</Condition>
                <Name>Log-Response-OK</Name>
            </Step>
            <Step>
                <Condition>response.status.code GreaterThan 300</Condition>
                <Name>Log-Response-NOT-OK</Name>
            </Step>
        </Response>
    </PreFlow>
    <PostFlow name="my-postflows">
        <Description>My first PostFlow</Description>
        <Response>
            <Step>
                <Name>Set-Response-Headers</Name>
            </Step>
        </Response>
    </PostFlow>
  ...
</ProxyEndpoint>

Атрибуты

У элемента <Response> нет атрибутов.

Дочерние элементы

В таблице ниже описаны дочерние элементы <Response>.

Дочерний элемент Тип Описание
<Condition> Строка Определяет, выполняются ли шаги в сегменте ответа.
<Step> Строка Указывает правило, которое нужно выполнить в сегменте ответа.

<Step>

Указывает правило для выполнения и (необязательное) условие, определяющее, следует ли выполнять это правило.

Тип Сложный объект
Родительские элементы <Request>
<Response>
Дочерние элементы <Condition>
<Name>

В элементе <Flow> может быть определено несколько шагов, которые выполняются в том порядке, в котором они указаны в XML-файле потока.

Шаги без условия выполняются всегда. Шаги с условием выполняются, только если условие истинно. Если условие не выполняется, Edge пропускает шаг.

Синтаксис

Элемент <Step> имеет следующий синтаксис:

<Step>
  <Condition>property operator "value"</Condition>
  <Name>policy_name</Name>
</Step>

В одном <Step> может быть только один элемент <Condition> и один элемент <Name>, но в одном элементе <Flow> может быть несколько шагов.

Все дочерние элементы <Step> являются необязательными.

Пример 1

В примере ниже показан один шаг с условием и один шаг без условия:

<!-- api-platform/reference/examples/flow-segments/step-1.xml -->
<ProxyEndpoint name="default">
  <PostFlow name="my-postflows">
      <Description>My first PostFlow</Description>
      <Request>
          <Step>
              <Condition>request.verb = "GET"</Condition>
              <Name>Log-Request-OK</Name>
          </Step>
      </Request>
      <Response>
          <Step>
              <Name>Set-Response-Headers</Name>
          </Step>
      </Response>
  </PostFlow>
  ...
</ProxyEndpoint>

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

Пример 2

В примере ниже показано несколько шагов в одном сегменте:

<!-- api-platform/reference/examples/flow-segments/step-2.xml -->
<ProxyEndpoint name="default">
    <PostFlow name="PostFlow">
        <Response>
            <Step>
                <Name>Assign-Message-1</Name>
            </Step>
            <Step>
                <Name>Assign-Message-2</Name>
            </Step>
        </Response>
    </PostFlow>
  ...
</ProxyEndpoint>

Шаги без условия выполняются всегда.

Атрибуты

У элемента <Step> нет атрибутов.

Дочерние элементы

В таблице ниже описаны дочерние элементы <Step>.

Дочерний элемент Тип Описание
<Condition> Строка Определяет условное выражение для шага, который обрабатывается во время выполнения. Если выражение истинно, Edge выполняет шаг. Если утверждение ложно, Edge пропускает шаг.
<Name> Строка Указывает идентификатор политики, которая будет выполняться в текущем потоке.