Политика ExtractVariables

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

Что

Политика 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 для создания отчетов Analytics на основе контента, см. раздел Анализ содержимого сообщений 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 , чтобы рассматривать любую неразрешимую переменную как пустую строку (ноль). Установите значение false если вы хотите, чтобы политика выдавала ошибку, когда любая ссылочная переменная неразрешима.

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

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

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

Элемент <URIPath>

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

<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>

Атрибуты

Элемент <ФормаПарам>

(Необязательно, но дополнительную информацию см. в строке «Присутствие» в таблице ниже.) Извлекает значение из указанного параметра формы указанного запроса или ответного сообщения. Параметры формы можно извлечь только в том случае, если заголовок 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>/<Пространства имен>

(Необязательно) Указывает пространство имен, которое будет использоваться при оценке 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>

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

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

<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 с помощью пользовательской аналитики.

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