Политика ExtractVariables

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

Что

Политика ExtractVariables извлекает содержимое из запроса или ответа и присваивает значение переменной, равное этому содержимому. Вы можете извлечь любую часть сообщения, включая заголовки, пути URI, полезные данные JSON/XML, параметры форм и параметры запросов. Политика работает, применяя текстовый шаблон к содержимому сообщения и, при обнаружении совпадения, присваивает переменной указанное содержимое сообщения.

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

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

Видео

Посмотрите следующие видео, чтобы узнать больше о политике ExtractVariables.

Образцы

Эти примеры кода политики иллюстрируют, как извлекать переменные из следующих типов артефактов:

<ExtractVariables name="ExtractVariables-1">
   <DisplayName>Extract a portion of the url path</DisplayName>
   <Source>request</Source>
   <URIPath>
      <Pattern ignoreCase="true">/accounts/{id}</Pattern>
   </URIPath>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="AssignPayload">
 <DisplayName>AssignPayload</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <IdExtractedFromURI>{urirequest.id}</IdExtractedFromURI>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="true" transport="http" type="request">newRequest</AssignTo>
</AssignMessage>

<ExtractVariables name="ExtractVariables-2">
   <DisplayName>Extract a value from a query parameter</DisplayName>
   <Source>request</Source>
   <QueryParam name="code">
      <Pattern ignoreCase="true">DBN{dbncode}</Pattern>
   </QueryParam>
   <VariablePrefix>queryinfo</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetQP</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractQP>{queryinfo.dbncode}</ExtractQP>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name="ExtractVariables-2">
   <DisplayName>Extract a value from a query parameter</DisplayName>
   <Source>request</Source>
   <QueryParam name="w">
      <Pattern ignoreCase="true">{firstWeather}</Pattern>
   </QueryParam>
   <QueryParam name="w.2">
     <Pattern ignoreCase="true">{secondWeather}</Pattern>
   </QueryParam>
   <VariablePrefix>queryinfo</VariablePrefix>
 <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetQP</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractQP1>{queryinfo.firstWeather}</ExtractQP1>
    <ExtractQP2>{queryinfo.secondWeather}</ExtractQP2>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name='ExtractVariable-OauthToken'>
  <Source>request</Source>
  <Header name="Authorization">
    <Pattern ignoreCase="false">Bearer {oauthtoken}</Pattern>
  </Header>
  <VariablePrefix>clientrequest</VariablePrefix>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetHeader</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractHeader>{clientrequest.oauthtoken}</ExtractHeader>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name="ExtractVariables-3">
   <Source>response</Source>
   <JSONPayload>
      <Variable name="latitude" type="float">
         <JSONPath>$.results[0].geometry.location.lat</JSONPath>
      </Variable>
      <Variable name="longitude" type="float">
         <JSONPath>$.results[0].geometry.location.lng</JSONPath>
      </Variable>
   </JSONPayload>
   <VariablePrefix>geocoderesponse</VariablePrefix>
</ExtractVariables>

{
  "results": [{
    "geometry": {
      "location": {
        "lat": 37.42291810,
        "lng": -122.08542120
      },
      "location_type": "ROOFTOP",
      "viewport": {
        "northeast": {
          "lat": 37.42426708029149,
          "lng": -122.0840722197085
        },
        "southwest": {
          "lat": 37.42156911970850,
          "lng": -122.0867701802915
        }
      }
    }
  }]
}

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
  <DisplayName>GetJSONVar</DisplayName>
  <Add>
    <Headers>
      <Header name="latitude">{geocoderesponse.latitude}</Header>
    </Headers>
  </Add>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

<ExtractVariables name="ExtractVariables-4">
   <Source>response</Source>
   <XMLPayload>
      <Namespaces>
         <Namespace prefix="dir">urn:43BFF88D-D204-4427-B6BA-140AF393142F</Namespace>
      </Namespaces>
      <Variable name="travelmode" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/@mode</XPath>
      </Variable>
      <Variable name="duration" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/dir:duration/dir:value</XPath>
      </Variable>
      <Variable name="timeunit" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/dir:duration/dir:text</XPath>
      </Variable>
   </XMLPayload>
   <VariablePrefix>directionsresponse</VariablePrefix>
</ExtractVariables>

<Directions xmlns="urn:43BFF88D-D204-4427-B6BA-140AF393142F">
   <status>OK</status>
   <route>
      <summary>I-40 W</summary>
      <leg>
         <step mode="DRIVING">
            <start_location>
               <lat>41.8507300</lat>
               <lng>-87.6512600</lng>
            </start_location>
            <end_location>
               <lat>41.8525800</lat>
               <lng>-87.6514100</lng>
            </end_location>
            <duration>
                <value>19</value>
                <text>minutes</text>
            </duration>
         </step>
      </leg>
   </route>
</Directions>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
  <DisplayName>GetXMLVar</DisplayName>
  <Add>
    <Headers>
      <Header name="tmode">{directionsresponse.travelmode}</Header>
    </Headers>
  </Add>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

О политике ExtractVariables

Разработчики API создают API-прокси, которые ведут себя по-разному в зависимости от содержимого сообщений, включая заголовки, пути URI, полезные данные и параметры запроса. Часто прокси-сервер извлекает часть этого содержимого для использования в операторе условия. Для этого используйте политику ExtractVariables.

При определении политики ExtractVariables вы можете выбрать:

• Имена переменных, которые необходимо установить
• Источник переменных
• Сколько переменных нужно извлечь и установить?

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

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

Объем

Переменные, заданные политикой ExtractVariables, имеют глобальную область действия. То есть, после того, как политика ExtractVariables определит новую переменную, к ней можно будет получить доступ из любой политики или кода на любом этапе выполнения (выполняемого после политики ExtractVariables). Это включает в себя:

• PreFlow: ProxyEndpoint и TargetEndpoint (запрос и ответ)
• PostFlow: ProxyEndpoint и TargetEndpoint (запрос и ответ)
• PostClientFlow: ProxyEndpoint (только ответ, с использованием политики ведения журнала сообщений )
• Потоки ошибок

О сопоставлении и создании переменных

Политика ExtractVariables извлекает информацию из запроса или ответа и записывает её в переменную. Для каждого типа информации, которую можно извлечь, например, пути URI или XML-данных, необходимо указать шаблон для сопоставления и имя переменной, используемой для хранения извлечённой информации.

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

Сопоставление путей URI, параметров запроса, заголовков, параметров формы и переменных

При извлечении информации из пути URI, параметров запроса, заголовков, параметров формы и переменных тег <Pattern> используется для указания одного или нескольких шаблонов для сопоставления. Например, в следующем примере политики показан один шаблон сопоставления для пути URI:

<ExtractVariables name="ExtractVariables-1">
   <Source>request</Source>
   <URIPath>
      <Pattern ignoreCase="true">/a/{pathSeg}</Pattern>
   </URIPath>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

В этом примере переменная urirequest.pathSeg задаётся значением, указанным в суффиксе proxy.path после "/a/". Например, предположим, что базовый путь для вашего API-прокси — /basepath/v1 . При входящем запросе на http://myCo.com/basepath/v1/a/b переменная задаётся значением "b".

Указание нескольких шаблонов

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

• Все шаблоны проверяются на соответствие.
• Если ни один из шаблонов не совпадает, политика ничего не делает и переменная(ые) не создается(ются).
• Если совпадает более одного шаблона, для извлечения используется шаблон с самыми длинными сегментами пути.
• Если два сопоставленных шаблона имеют одинаковые самые длинные сегменты пути, то для извлечения используется шаблон, указанный первым в политике.

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

<ExtractVariables name="ExtractVariables-1">
   <Source>request</Source>
   <URIPath>
      <Pattern ignoreCase="true">/a/{pathSeg}</Pattern>
      <Pattern ignoreCase="true">/a/b/{pathSeg}</Pattern>
      <Pattern ignoreCase="true">/a/b/c/{pathSeg}</Pattern>
   </URIPath>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

Предположим, что для API-прокси с базовым путем /basepath/v1 URL-адрес входящего запроса к API-прокси имеет следующий вид:

http://myCo.com/basepath/v1/a/b

В этом примере первый шаблон соответствует URI, а переменная urirequest.pathSeg имеет значение «b».

Если URL-адрес запроса:

http://myCo.com/basepath/v1/a/b/c/d

...тогда третий шаблон совпадает и переменная urirequest.pathSeg устанавливается в значение «d».

Указание шаблонов с несколькими переменными

В шаблоне сопоставления можно указать несколько переменных. Например, можно указать шаблон сопоставления с двумя переменными:

<ExtractVariables name="ExtractVariables-1">
   <Source>request</Source>
   <URIPath>
      <Pattern ignoreCase="true">/a/{pathSeg}</Pattern>
      <Pattern ignoreCase="true">/a/b/{pathSeg}</Pattern>
      <Pattern ignoreCase="true">/a/{pathSeg1}/c/{pathSeg2}</Pattern>
   </URIPath>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

Снова предположим, что API-прокси с базовым путем /basepath/v1 для URL-адреса входящего запроса:

http://myCo.com/basepath/v1/a/b/c/d

...переменная urirequest.pathSeg1 имеет значение «b», а переменная urirequest.pathSeg2 имеет значение «d».

Сопоставление нескольких экземпляров в шаблоне

Вы также можете сопоставлять шаблоны, когда существует несколько экземпляров элемента с одинаковым именем. Например, вы можете создать запрос, содержащий несколько параметров запроса или несколько заголовков с одинаковым именем. Следующий запрос содержит два параметра запроса с именем «w»:

http://myCo.com/basepath/v1/a/b/c/d?w=1&w=2

Для ссылки на эти параметры запроса в политике ExtractVariables используются индексы, где первый экземпляр параметра запроса не имеет индекса, второй находится под индексом 2, третий — под индексом 3 и т. д. Например, следующая политика извлекает значение второго параметра запроса с именем «w» в запросе:

<ExtractVariables name="ExtractVariables-1">
   <Source>request</Source>
   <QueryParam name="w.2">
      <Pattern ignoreCase="true">{secondW}</Pattern>
   </QueryParam>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

Переменная urirequest.secondW имеет значение «2». Если второй параметр запроса опущен, переменная urirequest.secondW будет пустой. Используйте индексирование всегда, когда в запросе есть несколько элементов с одинаковым именем.

Использование специальных символов в шаблоне

При сопоставлении путей URI в шаблоне можно использовать подстановочные символы «*» и «**», где:

• «*» соответствует любому сегменту пути
• «**» соответствует нескольким сегментам пути

Например, вы указываете шаблоны для элемента <URIPath> , как показано ниже:

<URIPath>
  <Pattern ignoreCase="true">/a/*/{id}</Pattern>
  <Pattern ignoreCase="true">/a/**/{id}</Pattern>
</URIPath>

Первый шаблон сопоставляет запросы с суффиксами пути (частью пути URI, следующей за базовым путем), такими как «/a/b/c», «/a/foo/bar» и т. д. Второй шаблон сопоставляет любое количество сегментов пути после «/a/», такими как «/a/foo/bar/baz/c», а также «/a/b/c» и «/a/foo/bar».

При указании шаблонов для параметров запроса, заголовков и параметров формы символ «*» указывает на соответствие любому количеству символов. Например, при сопоставлении заголовка укажите шаблон следующим образом:

*;charset={кодировка}

Этот шаблон соответствует значениям «text/xml;charset=UTF-16» и «application/xml;charset=ASCII».

Если значение, переданное политике ExtractVariables, содержит специальный символ, например «{», используйте символ «%» для его экранирования. В следующем примере символы «{» и «}» в шаблоне экранируются, поскольку они используются как литеральные символы в значении параметра запроса:

<QueryParam>
  <Pattern ignoreCase="true">%{user%} {name}</Pattern>
</QueryParam>

В этом примере шаблон соответствует значению «{user} Steve», но не значению «user Steve».

Сопоставление JSON и XML

При извлечении данных из JSON и XML в политике указывается один или несколько тегов <Variable> . Тег <Variable> определяет имя целевой переменной, в которой хранится извлеченная информация, а также путь к извлеченной информации (JsonPath (JSON)) или путь к извлеченной информации (XPATH (XML)).

Все теги <Variable> в политике оцениваются, что позволяет заполнять несколько переменных из одной политики. Если тег <Variable> не соответствует допустимому полю в JSON или XML, соответствующая переменная не создаётся.

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

<ExtractVariables name="ExtractVariables-3">
   <Source>response</Source>
   <JSONPayload>
      <Variable name="latitude" type="float">
         <JSONPath>$.results[0].geometry.location.lat</JSONPath>
      </Variable>
      <Variable name="longitude" type="float">
         <JSONPath>$.results[0].geometry.location.lng</JSONPath>
      </Variable>
   </JSONPayload>
   <VariablePrefix>geocoderesponse</VariablePrefix>
</ExtractVariables>

Запись одной и той же переменной в нескольких местах

Будьте внимательны при выборе имён устанавливаемых переменных. Политика выполняется последовательно от первого шаблона извлечения к последнему. Если политика записывает значение в одну и ту же переменную из нескольких мест, последняя запись в политике определяет значение переменной. (Возможно, это то, что вам нужно.)

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

<!-- If token only in query param, the query param determines the value.
     If token is found in both the query param and header, header sets value. -->
<QueryParam name="token">
  <Pattern ignoreCase="true">{tokenValue}</Pattern>
</QueryParam>

<!-- Overwrite tokenValue even if it was found in query parameter. -->
<Header name="Token">
  <Pattern ignoreCase="true">{tokenValue}</Pattern>
</Header>

Управление действиями при отсутствии совпадений

Если шаблон не совпадает, соответствующая переменная не создаётся. Поэтому, если другая политика ссылается на переменную, это может привести к ошибке.

Одним из вариантов является установка для параметра <IgnoreUnresolvedVariables> значения true в политике, которая ссылается на переменную, чтобы настроить политику на обработку любой неразрешимой переменной как пустой строки (null):

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Ссылка на элемент

Ссылка на элемент описывает элементы и атрибуты политики ExtractVariables.

<ExtractVariables async="false" continueOnError="false" enabled="true" name="Extract-Variables-1">
   <DisplayName>Extract Variables 1</DisplayName>
   <Source clearPayload="true|false">request</Source>
   <VariablePrefix>myprefix</VariablePrefix>
   <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>
   <URIPath>
      <Pattern ignoreCase="false">/accounts/{id}</Pattern>
   </URIPath>
   <QueryParam name="code">
      <Pattern ignoreCase="true">DBN{dbncode}</Pattern>
   </QueryParam>
   <Header name="Authorization">
      <Pattern ignoreCase="false">Bearer {oauthtoken}</Pattern>
   </Header>
   <FormParam name="greeting">
      <Pattern>hello {user}</Pattern>
   </FormParam>
   <Variable name="request.content">
       <Pattern>hello {user}</Pattern>
   </Variable>
   <JSONPayload>
      <Variable name="name">
         <JSONPath>{example}</JSONPath>
      </Variable>
   </JSONPayload>
   <XMLPayload stopPayloadProcessing="false">
      <Namespaces/>
      <Variable name="name" type="boolean">
         <XPath>/test/example</XPath>
      </Variable>
   </XMLPayload>
</ExtractVariables>

Атрибуты <ExtractVariables>

<ExtractVariables async="false" continueOnError="false" enabled="true" name="Extract-Variables-1">

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <Источник>

(Необязательно) Указывает переменную для анализа. Значение <Source> по умолчанию — message . Значение message зависит от контекста. В потоке запросов message преобразуется в сообщение запроса. В потоке ответов message преобразуется в сообщение ответа.

Хотя эта политика часто используется для извлечения информации из запроса или ответа, её можно использовать и для извлечения информации из любой переменной. Например, её можно использовать для извлечения информации из сущности, созданной политикой AccessEntity , из данных, возвращаемых политикой Service Callout , или извлечения информации из объекта XML или JSON.

Если <Source> не может быть разрешен или разрешен как тип, не являющийся сообщением, политика не ответит.

<Source clearPayload="true|false">request</Source>

Атрибуты

элемент <VariablePrefix>

(Необязательно) Полное имя переменной создаётся путём объединения префикса <VariablePrefix> , точки и имени, указанного в фигурных скобках {фигурные скобки} в элементе <Pattern> или элементе <Variable> . Например: myprefix.id , myprefix.dbncode или myprefix.oauthtoken.

<VariablePrefix>myprefix</VariablePrefix>

Например, предположим, что значение имени — «пользователь».

• Если <VariablePrefix> не указан, извлеченные значения присваиваются переменной с именем user .
• Если <VariablePrefix> указан как myprefix, извлеченные значения присваиваются переменной с именем myprefix.user .

Элемент <IgnoreUnresolvedVariables>

(Необязательно) Установите значение true , чтобы рассматривать любую неразрешимую переменную как пустую строку (null). Установите значение false , чтобы политика выдавала ошибку, если любая указанная переменная неразрешима.

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Если ссылка XPath не разрешена в <XMLPayload> , политика выдает следующую ошибку:

{
   "fault":{
      "faultstring":"Unresolved xpath path in policy policy_name.",
      "detail":{
         "errorcode":"steps.extractvariables.InvalidXPath"
      }
   }
}

Элемент <URIPath>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Извлекает значение из proxy.pathsuffix исходного сообщения запроса . Путь, применяемый к шаблону, — это proxy.pathsuffix, который не включает базовый путь для прокси-сервера API. Если исходное сообщение разрешается в тип сообщения response , этот элемент не выполняет никаких действий.

<URIPath>
   <Pattern ignoreCase="false">/accounts/{id}</Pattern>
</URIPath>

Можно использовать несколько элементов <Pattern> :

<URIPath>
   <Pattern ignoreCase="false">/accounts/{id}</Pattern>
   <Pattern ignoreCase="false">/accounts/{id}/transactions/{index}</Pattern>
</URIPath>

Атрибуты

элемент <QueryParam>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Извлекает значение из указанного параметра запроса исходного сообщения запроса . Если исходное сообщение разрешается в тип сообщения «ответ» , то этот элемент не выполняет никаких действий.

<QueryParam name="code">
   <Pattern ignoreCase="true">DBN{dbncode}</Pattern>
</QueryParam>

Если несколько параметров запроса имеют одинаковое имя, используйте индексы для ссылки на параметры:

<QueryParam name="w.2">
   <Pattern ignoreCase="true">{secondW}</Pattern>
</QueryParam>

Атрибуты

Элемент <Заголовок>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Извлекает значение из указанного HTTP-заголовка указанного запроса или ответа . Если несколько заголовков имеют одинаковое имя, их значения сохраняются в массиве.

<!-- The name is the actual header name. -->
<Header name="Authorization">
<!-- Provide a name for your new custom variable here. -->
   <Pattern ignoreCase="false">Bearer {oauthtoken}</Pattern>
</Header>

Если несколько заголовков имеют одинаковое имя, используйте индексы для ссылки на отдельные заголовки в массиве:

<Header name="myHeader.2">
   <Pattern ignoreCase="true">{secondHeader}</Pattern>
</Header>

Или следующее, чтобы вывести список всех заголовков в массиве:

<Header name="myHeader.values">
   <Pattern ignoreCase="true">{myHeaders}</Pattern>
</Header>

Атрибуты

элемент <FormParam>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Извлекает значение из указанного параметра формы указанного сообщения запроса или ответа . Параметры формы могут быть извлечены только в том случае, если заголовок Content-Type указанного сообщения имеет значение application/x-www-form-urlencoded .

<FormParam name="greeting">
    <Pattern>hello {user}</Pattern>
</FormParam>

Атрибуты

Элемент <Переменная>

(Необязательно, но для получения дополнительной информации см. строку «Присутствие» в таблице ниже.) Указывает имя переменной, из которой следует извлечь значение.

<Variable name="myVar">
    <Pattern>hello {user}</Pattern>
</Variable>

Чтобы извлечь два значения из переменной:

<Variable name="myVar">
   <Pattern>hello {firstName} {lastName}</Pattern>
</Variable>

Атрибуты

Элемент <JSONPayload>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Указывает сообщение в формате JSON, из которого будет извлечено значение переменной. Извлечение JSON выполняется только в том случае, если заголовок Content-Type сообщения — application/json .

<JSONPayload>
   <Variable name="name" type="string">
      <JSONPath>{example}</JSONPath>
   </Variable>
</JSONPayload>

Элемент <JSONPayload>/<Variable>

(Обязательно в элементе JSONPayload.) Указывает переменную, которой присваивается извлечённое значение. Вы можете включить несколько тегов <Variable> в элемент <JSONPayload> для заполнения нескольких переменных.

<Variable name="name" type="string">
   <JSONPath>{example}</JSONPath>
</Variable>

Атрибуты

Элемент <JSONPayload>/<Variable>/<JSONPath>

(Обязательно в элементе JSONPayload:Variable.) Указывает путь JSON, используемый для извлечения значения из сообщения в формате JSON.

<Variable name="name">
   <JSONPath>$.rss.channel.title</JSONPath>
</Variable>

Элемент <XMLPayload>

(Необязательно, но см. строку «Присутствие» в таблице ниже для получения дополнительной информации.) Указывает сообщение в формате XML, из которого будет извлечено значение переменной. Полезные данные XML извлекаются только в том случае, если заголовок Content-Type сообщения — text/xml , application/xml или application/*+xml .

<XMLPayload stopPayloadProcessing="false">
  <Namespaces>
     <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     <Namespace prefix="gmail">http://mail.google.com</Namespace>
  </Namespaces>
  <Variable name="name" type="boolean">
     <XPath>/apigee:test/apigee:example</XPath>
  </Variable>
</XMLPayload>

Атрибуты

Элемент <XMLPayload>/<Namespaces>

(Необязательно) Указывает пространство имён, которое будет использоваться при оценке XPath. Если вы используете пространства имён в выражениях XPath, необходимо объявить их здесь, как показано в следующем примере.

<XMLPayload stopPayloadProcessing="false">
  <Namespaces>
     <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     <Namespace prefix="gmail">http://mail.google.com</Namespace>
  </Namespaces>
  <Variable name="legName" type="string">
    <XPath>/apigee:Directions/apigee:route/apigee:leg/apigee:name</XPath>
  </Variable>
</XMLPayload>

Если вы не используете пространства имен в выражениях XPath, вы можете опустить или закомментировать элемент <Namespaces> , как показано в следующем примере:

<XMLPayload stopPayloadProcessing="false">
  <!-- <Namespaces/> -->
  <Variable name="legName" type="string">
    <XPath>/Directions/route/leg/name</XPath>
  </Variable>
</XMLPayload>

Атрибуты

Элемент <XMLPayload>/<Variable>

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

<Variable name="name" type="boolean">
   <XPath>/test/example</XPath>
</Variable>

Атрибуты

Элемент <XMLPayload>/<Variable>/<XPath>

(Обязательно в элементе XMLPayload:Variable.) Указывает XPath, заданный для переменной. Поддерживаются только выражения XPath 1.0.

<Variable name="name" type="boolean">
   <XPath>/test/example</XPath>
</Variable>

Пример с пространством имён. Если вы используете пространства имён в выражениях XPath, необходимо объявить их в разделе <XMLPayload><Namespaces> политики.

<Variable name="name" type="boolean">
   <XPath>/foo:test/foo:example</XPath>
</Variable>

Ссылка на ошибку

В этом разделе описаны коды ошибок и сообщения об ошибках, которые возвращаются, а также переменные ошибок, которые устанавливаются Edge, когда эта политика вызывает ошибку. Эту информацию важно знать, если вы разрабатываете правила обработки ошибок. Дополнительные сведения см. в разделах Что нужно знать об ошибках политики и Обработка ошибок .

Ошибки выполнения

Эти ошибки могут возникнуть при выполнении политики.

Ошибки развертывания

Эти ошибки могут возникнуть при развертывании прокси-сервера, содержащего эту политику.

Переменные неисправности

Эти переменные устанавливаются, когда эта политика вызывает ошибку во время выполнения. Дополнительные сведения см. в разделе Что нужно знать об ошибках политики .

Пример ответа об ошибке

{
   "fault":{
      "detail":{
         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
      },
      "faultstring":"request message is not available for ExtractVariable: EV-ParseJsonResponse"
   }
}

Пример правила неисправности

<FaultRule name="Extract Variable Faults">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name = "SourceMessageNotAvailable") </Condition>
    </Step>
    <Condition>(extractvariables.EM-ParseJsonResponse.failed = true) </Condition>
</FaultRule>

Схемы

Похожие темы

Анализируйте содержимое сообщений API с помощью пользовательской аналитики

Справочник переменных