Criterio ExtractVariables

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Il criterio ExtractVariables estrae contenuti da una richiesta o risposta e imposta il valore di una variabile per quei contenuti. Puoi estrarre qualsiasi parte del messaggio, tra cui intestazioni, percorsi URI, payload JSON/XML, parametri e parametri di ricerca. Il criterio funziona applicando un pattern di testo al messaggio e, quando viene trovata una corrispondenza, imposta una variabile con il contenuto del messaggio specificato.

Anche se spesso utilizzi questo criterio per estrarre informazioni da un messaggio di richiesta o di risposta, puoi utilizzarlo anche per estrarre informazioni da altre fonti, comprese le entità create criteri di AccessEntity, oggetti XML o JSON.

Dopo aver estratto i contenuti specificati del messaggio, puoi fare riferimento alla variabile in altri nell'ambito dell'elaborazione di richieste e risposte.

Video

Guarda i seguenti video per scoprire di più sul criterio ExtractVariables.

Esempi

Questi esempi di codice dei criteri illustrano come estrarre variabili dai seguenti tipi di artefatti:

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

Informazioni sul criterio ExtractVariables

Gli sviluppatori di API creano proxy API che si comportano diversamente in base ai contenuti dei messaggi. come intestazioni, percorsi URI, payload e parametri di ricerca. Spesso, il proxy estrae alcune di questi contenuti per l'utilizzo in un'istruzione di condizione. Per farlo, utilizza il criterio ExtractVariables. questo.

Quando definisci il criterio ExtractVariables, puoi scegliere:

• Nomi delle variabili da impostare
• Origine delle variabili
• Numero di variabili da estrarre e impostare

Una volta eseguita, la norma applica un pattern di testo ai contenuti e, quando viene trovata una corrispondenza, imposta il valore della variabile designata con i contenuti. Altri criteri e codice possono quindi consumare per abilitare il comportamento dinamico o inviare dati aziendali all'analisi API Edge.

Per informazioni su come utilizzare ExtractVariables per creare report di Analytics basati sui contenuti, consulta Analisi Contenuti dei messaggi delle API mediante analisi personalizzate.

Ambito

Le variabili impostate con il criterio ExtractVariables hanno un ambito globale. Cioè, dopo che Il criterio ExtractVariables definisce una nuova variabile, puoi accedervi da qualsiasi criterio o in qualsiasi fase del flusso (che viene eseguita dopo il criterio ExtractVariables). Questo include:

• PreFlow: ProxyEndpoint e TargetEndpoint (richiesta e risposta)
• PostFlow: ProxyEndpoint e TargetEndpoint (richiesta e risposta)
• PostClientFlow: ProxyEndpoint (solo risposta, utilizzando criterio di logging dei messaggi)
• Flussi di errori

Informazioni sulla corrispondenza e sulla creazione di variabili

Il criterio ExtractVariables estrae informazioni da una richiesta o risposta e scrive che a una variabile. Per ogni tipo di informazione che si può estrarre, come il percorso URI dati XML, devi specificare il pattern da abbinare e il nome della variabile utilizzata per contenere le informazioni estratte.

Tuttavia, il funzionamento della corrispondenza dei pattern dipende dall'origine dell'estrazione. Le seguenti descrivono le due categorie base di informazioni che è possibile estrarre.

Percorsi degli URI, parametri di ricerca, intestazioni, parametri del modulo e variabili corrispondenti

Quando si estrae informazioni da un percorso URI, parametri di ricerca, le intestazioni, i parametri del modulo variabili che utilizzi il tag <Pattern> per specificare una o più pattern corrispondenti. Il seguente criterio di esempio mostra un singolo pattern di corrispondenza per il percorso dell'URI:

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

In questo esempio, la variabile urirequest.pathSeg è impostata a qualsiasi elemento visualizzato nel proxy.pathsuffix dopo "/a/". Ad esempio, supponiamo che il percorso di base il proxy API è /basepath/v1 . Con una richiesta in entrata alla pagina http://myCo.com/basepath/v1/a/b il sia impostata su "b".

Specificare più pattern

Puoi specificare più pattern da abbinare, corrispondenti ai tag <Pattern>, dove:

• Tutti i pattern vengono testati per rilevare la corrispondenza.
• Se nessuno dei pattern corrisponde, il criterio non fa nulla e la variabile o le variabili non è stato creato.
• Se più pattern corrispondono, quello con i segmenti di percorso più lunghi viene utilizzato l'estrazione dei contenuti.
• Se due pattern corrispondenti hanno gli stessi segmenti di percorso più lunghi, il pattern specificato per primo in il criterio viene usato per l'estrazione.

Nel prossimo esempio creerai un criterio che contiene tre pattern corrispondenti per l'URI percorso:

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

Supponi, per un proxy API con percorso base /basepath/v1 , che l'URL della richiesta in entrata al proxy API ha il seguente formato:

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

In questo esempio, il primo pattern corrisponde all'URI e la variabile urirequest.pathSeg è impostato su "b".

Se l'URL della richiesta è:

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

...il terzo pattern corrisponde e la variabile urirequest.pathSeg è impostato su "d".

Specificare i pattern con più variabili

Puoi specificare più variabili nel pattern corrispondente. Ad esempio, specifichi un pattern corrispondente con due variabili:

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

Supponendo di nuovo un proxy API con un percorso di base /basepath/v1 per la richiesta in entrata URL:

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

...la variabile urirequest.pathSeg1 è imposta su "b" e la variabile urirequest.pathSeg2 è impostato su "d".

Corrispondenza di più istanze nel pattern

Puoi anche far corrispondere i pattern quando sono presenti più istanze di un elemento con lo stesso nome. Ad esempio, puoi effettuare una richiesta contenente più parametri di ricerca o più intestazioni con lo stesso nome. La seguente richiesta contiene due parametri di ricerca denominati "w":

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

Per fare riferimento a questi parametri di query nel criterio ExtractVariables, puoi usare gli indici, dove la prima istanza del parametro di query non ha un indice, la seconda si trova all'indice 2, la terza all'indice indice 3 e così via. Ad esempio, il seguente criterio estrae il valore del secondo parametro di query denominato "w" nella richiesta:

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

La variabile urirequest.secondW è impostato su "2". Se il secondo parametro di query viene omesso dalla richiesta, la variabile urirequest.secondW è vuoto. Utilizza l'indicizzazione ogni volta che nella richiesta sono presenti più elementi con lo stesso nome.

Utilizzo di caratteri speciali nel pattern

Quando cerchi corrispondenze per i percorsi URI, puoi utilizzare il carattere "*" e "**" caratteri jolly nel pattern, dove:

• "*" corrisponde a qualsiasi segmento del percorso
• "**" corrisponde a più segmenti del percorso

Ad esempio, specifichi i pattern per l'elemento <URIPath> come illustrato sotto:

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

Il primo pattern associa le richieste ai pathuffix (la parte del percorso dell'URI che segue basepath) come "/a/b/c", "/a/foo/bar" e così via. Il secondo pattern corrisponde a un numero qualsiasi di percorsi segmenti dopo "/a/", ad esempio "/a/foo/bar/baz/c", nonché "/a/b/c" e "/a/foo/bar".

Quando specifichi i pattern per parametri di ricerca, le intestazioni e i parametri del modulo, il carattere "*" che deve corrispondere a un qualsiasi numero di caratteri. Ad esempio, quando cerchi una corrispondenza per un'intestazione, specifica come:

*;charset={encoding}

Questo pattern corrisponde ai valori "text/xml;charset=UTF-16" e "application/xml;charset=ASCII".

Se il valore passato al criterio ExtractVariables contiene un carattere speciale, come "{", utilizza "%" come carattere di escape. L'esempio seguente esegue il escape in "{" e "}" caratteri nel pattern perché vengono usati come caratteri letterali nel valore della query :

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

In questo esempio, il pattern corrisponde al valore "{user}" Steve" ma non il valore "utente Stefano".

JSON e XML corrispondenti

Quando estrai i dati da JSON e XML, specifichi uno o più tag <Variable> nel criterio. Il tag <Variable> specifica la nome della variabile di destinazione in cui sono archiviate le informazioni estratte e JsonPath (JSON) o XPATH (XML) alle informazioni estratte.

Tutti i tag <Variable> nel criterio. vengono valutati, in modo da poter completare più variabili da un unico criterio. Se Il tag <Variable> non restituisce un campo valido nel file JSON o XML, la variabile corrispondente non è stato creato.

L'esempio seguente mostra un criterio ExtractVariables che compila due variabili dalla Corpo JSON di una risposta:

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

Scrivendo al stessa variabile in più posizioni

Fai attenzione quando scegli i nomi delle variabili da impostare. Il criterio viene eseguito in sequenza da dal primo pattern di estrazione all'ultimo. Se il criterio scrive un valore nella stessa variabile da più posizioni, l'ultima scrittura nel criterio determina il valore della variabile. (Potrebbe trattarsi ovvero ciò che vuoi.

Ad esempio, vuoi estrarre un valore del token che può essere passato in un parametro di query o in un'intestazione, come mostrato di seguito:

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

Controllo di ciò che accade in assenza di corrispondenze

Se il pattern non corrisponde, la variabile corrispondente non viene creata. Pertanto, se un altro criterio fa riferimento alla variabile, questo può causare un errore.

Un'opzione è impostare <IgnoreUnresolvedVariables> su true in un criterio che fa riferimento alla variabile per configurare il criterio da trattare qualsiasi variabile non risolvibile come stringa vuota (null):

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi di 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> attributi

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

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

<DisplayName> elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

<Source> elemento

(Facoltativo) Specifica la variabile da analizzare. Il valore di Il valore predefinito di <Source> è message. Il valore message è sensibile al contesto. In un flusso di richiesta, message si risolve nel messaggio di richiesta. Nella un flusso di risposta, message si risolve nel messaggio di risposta.

Anche se spesso utilizzi questo criterio per estrarre informazioni da un messaggio di richiesta o di risposta, puoi utilizzarlo per estrarre informazioni da qualsiasi variabile. Ad esempio, puoi usarlo per estrarre informazioni di un'entità creata dal criterio AccessEntity, dai dati restituito dal servizio criterio callout o estrarre informazioni da un oggetto XML o JSON.

Se non è possibile risolvere <Source> o se viene risolto in un tipo non messaggio, il criterio non risponderà.

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

Attributi

<VariablePrefix> elemento

(Facoltativo) Il nome completo della variabile viene creato unendo il valore <VariablePrefix>, un punto e il nome che definisci tra {parentesi graffe} in Elemento <Pattern> o elemento <Variable>. Ad esempio: myprefix.id, myprefix.dbncode o myprefix.oauthtoken.

<VariablePrefix>myprefix</VariablePrefix>

Ad esempio, supponiamo che il valore del nome sia "utente".

• Se <VariablePrefix> non viene specificato, i valori estratti vengono assegnato a una variabile denominata user.
• Se <VariablePrefix> viene specificato come mioprefisso, il valore estratto I valori sono assegnati a una variabile denominata myprefix.user.

<IgnoreUnresolvedVariables> elemento

(Facoltativo) Imposta su true per trattare qualsiasi variabile non risolvibile come stringa vuota (nullo). Imposta su false se vuoi che il criterio generi un errore quando viene fatto riferimento non è risolvibile.

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Se un riferimento XPath non è risolto in un <XMLPayload>, il criterio genera il seguente errore:

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

<URIPath> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Estrae un valore dal proxy.pathsuffix di un messaggio di origine request. Il percorso applicato a il pattern è proxy.pathsuffix, che non include il basepath per il proxy API. Se il messaggio di origine si risolve in un tipo di messaggio response, questo elemento non produce alcun effetto.

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

È possibile utilizzare più elementi <Pattern>:

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

Attributi

<QueryParam> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Estrae un valore dal parametro di query specificato di un messaggio di origine request. Se il messaggio di origine si risolve in un tipo di messaggio response, questo elemento niente.

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

Se più parametri di ricerca hanno lo stesso nome, utilizza gli indici per fare riferimento ai parametri:

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

Attributi

<Header> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Estrae un valore dall'intestazione HTTP specificata del messaggio request o response specificato. Se più intestazioni contengono con lo stesso nome, i relativi valori sono archiviati in un array.

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

Se più intestazioni hanno lo stesso nome, utilizza gli indici per fare riferimento alle singole intestazioni nella array:

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

o di seguito per elencare tutte le intestazioni nell'array:

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

Attributi

<FormParam> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Estrae un valore dal parametro di modulo specificato del messaggio request o response specificato. Parametri modulo può essere estratta solo quando l'intestazione Content-Type del messaggio specificato è application/x-www-form-urlencoded.

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

Attributi

<Variable> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Specifica il parametro il nome di una variabile da cui estrarre un valore.

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

Per estrarre due valori dalla variabile:

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

Attributi

<JSONPayload> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Specifica il parametro Messaggio in formato JSON da cui verrà estratto il valore della variabile. JSON viene eseguita solo quando l'intestazione Content-Type del messaggio è application/json.

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

<JSONPayload>/<Variable> elemento

(Obbligatorio all'interno dell'elemento JSONPayload). Specifica la variabile in cui il valore estratto è assegnati. Puoi includere più tag <Variable> nell'elemento <Variable> da compilare più variabili.

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

Attributi

<JSONPayload>/<Variable>/<JSONPath> elemento

(Obbligatorio all'interno dell'elemento JSONPayload:Variable.) Specifica il percorso JSON utilizzato per estrarre un da un messaggio in formato JSON.

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

<XMLPayload> elemento

(Facoltativo, ma per saperne di più consulta la riga Presenza nella tabella seguente). Specifica il parametro Messaggio in formato XML da cui verrà estratto il valore della variabile. Payload XML vengono estratte solo quando l'intestazione Content-Type del messaggio è text/xml, application/xml, o 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>

Attributi

<XMLPayload>/<Namespaces> elemento

(Facoltativo) Specifica lo spazio dei nomi da utilizzare nella valutazione di XPath. Se utilizzi nelle tue espressioni XPath, devi dichiarare gli spazi dei nomi qui, come mostrato dall'esempio seguente.

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

Se non utilizzi gli spazi dei nomi nelle espressioni XPath, puoi omettere o commentare il <Namespaces>, come mostrato nell'esempio seguente:

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

Attributi

<XMLPayload>/<Variable> elemento

(Facoltativo) Specifica la variabile a cui verrà assegnato il valore estratto.

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

Attributi

<XMLPayload>/<Variable>/<XPath> elemento

(Obbligatorio all'interno dell'elemento XMLPayload:Variable.) Specifica l'XPath definito per . Sono supportate solo espressioni XPath 1.0.

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

Esempio con uno spazio dei nomi. Se utilizzi gli spazi dei nomi nelle espressioni XPath, devi dichiarare gli spazi dei nomi nella sezione <XMLPayload><Namespaces> delle norme.

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

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore impostate da Edge quando questo criterio attiva un errore. È importante sapere se stai sviluppando regole di errore per per gestire gli errori. Per saperne di più, consulta Cosa devi sapere sugli errori relativi ai criteri e sulla gestione di errore.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Variabili di errore

Queste variabili vengono impostate quando il criterio attiva un errore in fase di runtime. Per ulteriori informazioni, consulta Cosa che devi conoscere sugli errori relativi alle norme.

Esempio di risposta di errore

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

Esempio di regola di errore

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

Schemi

Argomenti correlati

API Analyze dei messaggi usando dati e analisi personalizzati

Riferimento per le variabili