Правило 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 создавать отчеты Аналитики на основе контента, ознакомьтесь со статьей Как анализировать контент сообщений 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.pathsuffix после "/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={encoding}

Этот шаблон соответствует значениям "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>

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

Предположим, что значение параметра name – "user".

• Если <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 исходного сообщения request. Путь, применяемый к шаблону, – это proxy.pathsuffix, который не включает basepath для прокси 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>

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

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

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

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

Атрибуты

Элемент <Header>

(Необязательно, но ознакомьтесь с информацией в строке "Присутствие" в таблице ниже.) Извлекает значение из указанного заголовка 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>

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

<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.) Указывает переменную, которой присваивается извлеченное значение. Чтобы заполнить несколько переменных, в элемент <JSONPayload> можно добавить несколько тегов <Variable>.

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

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