Criterio ExtractVariables

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Cosa

Il criterio ExtractVariables estrae i contenuti da una richiesta o una risposta e imposta il valore di una variabile su questi contenuti. Puoi estrarre qualsiasi parte del messaggio, inclusi intestazioni, percorsi URI, payload JSON/XML, parametri del modulo e parametri di query. La norma funziona applicando un pattern di testo ai contenuti del messaggio e, una volta trovata una corrispondenza, imposta una variabile con i contenuti del messaggio specificati.

Sebbene spesso utilizzi questa norma per estrarre informazioni da un messaggio di richiesta o risposta, puoi utilizzarla anche per estrarre informazioni da altre fonti, incluse entità create dalla norma AccessEntity, oggetti XML o oggetti JSON.

Dopo aver estratto i contenuti del messaggio specificati, puoi fare riferimento alla variabile in altre norme nell'ambito dell'elaborazione di una richiesta e di una risposta.

Video

Guarda i seguenti video per saperne di più sulla norma ExtractVariables.

Esempi

Questi esempi di codice delle policy mostrano come estrarre le 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 sulle norme ExtractVariables

Gli sviluppatori di API creano proxy API che si comportano in modo diverso in base al contenuto dei messaggi, inclusi intestazioni, percorsi URI, payload e parametri di query. Spesso, il proxy estrae una parte di questi contenuti da utilizzare in un'istruzione di condizione. Utilizza il criterio ExtractVariables per eseguire questa operazione.

Quando definisci la policy ExtractVariables, puoi scegliere:

• I nomi delle variabili da impostare
• Origine delle variabili
• Quante variabili estrarre e impostare

Quando viene eseguita, la norma applica un pattern di testo ai contenuti e, una volta trovata una corrispondenza, imposta il valore della variabile designata con i contenuti. Altre norme e codice possono quindi utilizzare queste variabili per attivare un comportamento dinamico o per inviare dati aziendali a Edge API Analytics.

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

Ambito

Le variabili impostate con il criterio ExtractVariables hanno un ambito globale. ovvero, dopo che la norma ExtractVariables definisce una nuova variabile, puoi accedere a questa variabile da qualsiasi norma o codice in qualsiasi fase del flusso (che viene eseguito dopo la norma ExtractVariables). Ciò include:

• PreFlow: ProxyEndpoint e TargetEndpoint (richiesta e risposta)
• PostFlow: ProxyEndpoint e TargetEndpoint (richiesta e risposta)
• PostClientFlow: ProxyEndpoint (solo risposta, utilizzando il criterio Message Logging)
• Flussi di errori

Informazioni sulla corrispondenza e sulla creazione di variabili

Il criterio ExtractVariables estrae informazioni da una richiesta o una risposta e le scrive in una variabile. Per ogni tipo di informazione che puoi estrarre, ad esempio il percorso URI o i dati XML, specifica 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 sezioni seguenti descrivono le due categorie di base di informazioni che puoi estrarre.

Corrispondenza di percorsi URI, parametri di query, intestazioni, parametri del modulo e variabili

Quando estrai informazioni da un percorso URI, parametri di ricerca, intestazioni, parametri del modulo e variabili, utilizzi il tag <Pattern> per specificare uno o più pattern da corrispondere. Ad esempio, il seguente esempio di policy mostra un singolo pattern di corrispondenza per il percorso 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 su qualsiasi valore venga visualizzato in proxy.pathsuffix dopo "/a/". Ad esempio, supponiamo che il percorso di base del tuo proxy API sia /basepath/v1 . Con una richiesta in entrata a http://myCo.com/basepath/v1/a/b la variabile è impostata su "b".

Specificare più pattern

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

• Tutti i pattern vengono testati per la corrispondenza.
• Se nessuno dei pattern corrisponde, il criterio non ha effetto e la variabile o le variabili non vengono create.
• Se più di un pattern corrisponde, viene utilizzato il pattern con i segmenti di percorso più lunghi per l'estrazione.
• Se due pattern corrispondenti hanno gli stessi segmenti di percorso più lunghi, per l'estrazione viene utilizzato il pattern specificato per primo nei criteri.

Nell'esempio successivo, crei una policy che contiene tre pattern di corrispondenza per il percorso 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>

Supponiamo che per un proxy API con un basepath di /basepath/v1, l'URL della richiesta in entrata al proxy API sia di questo formato:

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

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

Se l'URL della richiesta è:

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

...quindi il terzo pattern corrisponde e la variabile urirequest.pathSeg viene impostata su "d".

Specificare pattern con più variabili

Puoi specificare più variabili nel pattern di corrispondenza. Ad esempio, specifichi un pattern di corrispondenza 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 ancora 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 è impostata su "b" e la variabile urirequest.pathSeg2 è impostata su "d".

Corrispondenza di più istanze nel pattern

Puoi anche trovare corrispondenze con i pattern quando ci sono più istanze di un elemento con lo stesso nome. Ad esempio, puoi inviare una richiesta che contiene più parametri di query o più intestazioni con lo stesso nome. La seguente richiesta contiene due parametri di query 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, utilizzi gli indici, dove la prima istanza del parametro di query non ha indice, la seconda è all'indice 2, la terza all'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 è impostata su "2". Se il secondo parametro di query viene omesso dalla richiesta, la variabile urirequest.secondW è vuota. Utilizza l'indicizzazione ogni volta che nella richiesta sono presenti più elementi con lo stesso nome.

Utilizzo di caratteri speciali nel pattern

Quando metti in corrispondenza i percorsi URI, puoi utilizzare i caratteri jolly "*" e "**" nel pattern, dove:

• "*" corrisponde a uno qualsiasi dei segmenti del percorso
• "**" corrisponde a più segmenti del percorso

Ad esempio, specifica i pattern per l'elemento <URIPath> come mostrato di seguito:

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

Il primo pattern corrisponde alle richieste con suffissi di percorso (la parte del percorso URI che segue il percorso di base) come "/a/b/c", "/a/foo/bar" e così via. Il secondo pattern corrisponde a qualsiasi numero di segmenti di percorso dopo "/a/", ad esempio "/a/foo/bar/baz/c", nonché a "/a/b/c" e "/a/foo/bar".

Quando specifichi i pattern per i parametri di query, le intestazioni e i parametri del modulo, il carattere "*" indica di trovare una corrispondenza con qualsiasi numero di caratteri. Ad esempio, quando metti in corrispondenza un'intestazione, specifica il pattern 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, ad esempio "{", utilizza il carattere "%" per eseguirne l'escape. L'esempio seguente esegue l'escape dei caratteri "{" e "}" nel pattern perché vengono utilizzati come caratteri letterali nel valore del parametro di query:

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

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

Corrispondenza di JSON e XML

Quando estrai dati da JSON e XML, specifica uno o più tag <Variable> nel criterio. Il tag <Variable> specifica il nome della variabile di destinazione in cui vengono memorizzate le informazioni estratte e il JsonPath (JSON) o XPATH (XML) per le informazioni estratte.

Vengono valutati tutti i tag <Variable> nel criterio, in modo da poter compilare più variabili da un singolo criterio. Se il tag <Variable> non corrisponde a un campo valido nel JSON o nell'XML, la variabile corrispondente non viene creata.

L'esempio seguente mostra una policy ExtractVariables che popola due variabili dal 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>

Scrittura nella stessa variabile in più posizioni

Fai attenzione quando scegli i nomi delle variabili da impostare. Il criterio viene eseguito in sequenza 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 essere quello che vuoi.)

Ad esempio, vuoi estrarre un valore 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>

Controllare cosa succede quando non viene trovata alcuna corrispondenza

Se il pattern non corrisponde, la variabile corrispondente non viene creata. Pertanto, se un'altra norma fa riferimento alla variabile, può causare un errore.

Un'opzione consiste nell'impostare <IgnoreUnresolvedVariables> su true in un criterio che fa riferimento alla variabile per configurare il criterio in modo che tratti qualsiasi variabile non risolvibile come stringa vuota (nulla):

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Riferimento elemento

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

Attributi <ExtractVariables>

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

&lt;DisplayName&gt; 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>

Elemento <Source>

(Facoltativo) Specifica la variabile da analizzare. Il valore di <Source> è impostato per impostazione predefinita su message. Il valore message è sensibile al contesto. In un flusso di richieste, message viene risolto nel messaggio di richiesta. In un flusso di risposta, message viene risolto nel messaggio di risposta.

Sebbene questo criterio venga spesso utilizzato per estrarre informazioni da un messaggio di richiesta o risposta, puoi utilizzarlo per estrarre informazioni da qualsiasi variabile. Ad esempio, puoi utilizzarlo per estrarre informazioni da un'entità creata dal criterio AccessEntity, dai dati restituiti dal criterio Service Callout o estrarre informazioni da un oggetto XML o JSON.

Se <Source> non può essere risolto o viene risolto in un tipo non di messaggio, il criterio non risponderà.

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

Attributi

Elemento <VariablePrefix>

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

<VariablePrefix>myprefix</VariablePrefix>

Ad esempio, supponiamo che il valore di name sia "user".

• Se <VariablePrefix> non è specificato, i valori estratti vengono assegnati a una variabile denominata user.
• Se <VariablePrefix> è specificato come myprefix, i valori estratti vengono assegnati a una variabile denominata myprefix.user.

Elemento <IgnoreUnresolvedVariables>

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

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

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

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

Elemento <URIPath>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Estrae un valore da proxy.pathsuffix di un messaggio di origine richiesta. Il percorso applicato al pattern è proxy.pathsuffix, che non include il basepath per il proxy API. Se il messaggio di origine viene risolto in un tipo di messaggio response, questo elemento non fa nulla.

<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

Elemento <QueryParam>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Estrae un valore dal parametro di query specificato di un messaggio di origine richiesta. Se il messaggio di origine viene risolto in un tipo di messaggio response, questo elemento non fa nulla.

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

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

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

Attributi

Elemento <Header>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Estrae un valore dall'intestazione HTTP specificata del messaggio di richiesta o risposta specificato. Se più intestazioni hanno lo stesso nome, i relativi valori vengono memorizzati 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 nell'array:

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

Oppure il seguente per elencare tutte le intestazioni dell'array:

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

Attributi

Elemento <FormParam>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Estrae un valore dal parametro del modulo specificato del messaggio di richiesta o risposta specificato. I parametri del modulo possono essere estratti solo quando l'intestazione Content-Type del messaggio specificato è application/x-www-form-urlencoded.

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

Attributi

Elemento <Variable>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Specifica 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

Elemento <JSONPayload>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Specifica il messaggio in formato JSON da cui verrà estratto il valore della variabile. L'estrazione 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 a cui viene assegnato il valore estratto. Puoi includere più tag <Variable> nell'elemento <JSONPayload> per compilare più variabili.

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

Attributi

Elemento <JSONPayload>/<Variable>/<JSONPath>

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

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

Elemento <XMLPayload>

(Facoltativo, ma consulta la riga Presenza nella tabella seguente per ulteriori informazioni.) Specifica il messaggio in formato XML da cui verrà estratto il valore della variabile. I payload XML vengono estratti 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 XPath. Se utilizzi gli spazi dei nomi nelle espressioni XPath, devi dichiararli qui, come mostrato nell'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 spazi dei nomi nelle espressioni XPath, puoi omettere o commentare l'elemento <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

Elemento <XMLPayload>/<Variable>/<XPath>

(Obbligatorio all'interno dell'elemento XMLPayload:Variable.) Specifica l'XPath definito per la variabile. Sono supportate solo le 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 dichiararli nella sezione <XMLPayload><Namespaces> delle norme.

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

Messaggi di errore

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>

Schemi

Argomenti correlati

Analizzare i contenuti dei messaggi delle API mediante analisi personalizzate

Riferimento alle variabili