extraVariables politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

ExtractVariables politikası, bir istek veya yanıttaki içeriği ayıklar ve bir değişken oluşturabilirsiniz. Üstbilgiler, URI yolları, JSON/XML yükleri, form veya ve sorgu parametrelerini dahil etmektir. Politika, iletiye bir metin kalıbı uygulayarak çalışır bir eşleşme bulduğunda, belirtilen ileti içeriğiyle bir değişken ayarlar.

Bu politikayı genellikle bir istek veya yanıt mesajından bilgi ayıklamak için kullansanız da, tarafından oluşturulan varlıklar dahil olmak üzere diğer kaynaklardan bilgi ayıklamak için de kullanabilir. AccessEntity politikası XML nesneleri veya JSON nesneleri.

Belirtilen ileti içeriğini çıkardıktan sonra, diğer politika ve politikaların bir parçası olarak değerlendirilebilir.

Videolar

ExtractDeğişkenler politikası hakkında daha fazla bilgi edinmek için aşağıdaki videoları izleyin.

Örnekler

Bu politika kodu örnekleri, aşağıdaki türlerdeki değişkenlerin nasıl ayıklanacağını gösterir: yapın:

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

ExtractDeğişkenler politikası hakkında

API geliştiricileri, mesajların içeriğine göre farklı şekilde davranan API proxy'leri oluşturur. Buna başlıklar, URI yolları, yük ve sorgu parametreleri dahildir. Proxy, genellikle bölümünü koşul ifadesinde kullanılmak üzere bu içeriğin bir kısmına dahil etmeyi unutmayın. Aşağıdaki işlemler için ExtractVariables politikasını bu.

ExtractVariables politikasını tanımlarken şunları seçebilirsiniz:

• Ayarlanacak değişkenlerin adları
• Değişkenlerin kaynağı
• Çıkarılacak ve ayarlanacak değişken sayısı

Yürütüldükten sonra politika, içeriğe bir metin kalıbı uygular ve eşleşme bulduğunda içerikle birlikte belirtilen değişkenin değeri. Böylece diğer politikalar ve kodlar bu değişkenleri dinamik davranışı etkinleştirmek veya iş verilerini Edge API Analytics'e göndermek için kullanın.

İçerik odaklı Analytics raporları oluşturmak amacıyla ExtractVariables'ın nasıl kullanılabileceğini öğrenmek için Analiz Etme Özel analizler kullanan API mesaj içeriği.

Kapsam

ExtractVariables politikasıyla ayarlanan değişkenler genel kapsama sahiptir. Yani, ExtractDeğişkenler politikası yeni bir değişken tanımladığında, bu değişkene herhangi bir politika veya kodu (ExtractVariables politikasından sonra yürütülen) ekleyebilirsiniz. Bu şunları içerir:

• PreFlow: ProxyEndpoint ve TargetEndpoint (İstek ve Yanıt)
• PostFlow: ProxyEndpoint ve TargetEndpoint (İstek ve Yanıt)
• PostClientFlow: ProxyEndpoint (Yalnızca Yanıt, İleti Kaydı politikası)
• Hata Akışları

Eşleştirme ve değişken oluşturma hakkında

ExtractVariables politikası bir istek veya yanıttaki bilgileri ayıklar ve bir değişkene dönüştürmenizi sağlar. Ayıklayabileceğiniz her bilgi türü için (örneğin, URI yolu veya ile eşleşen kalıbı ve değeri tutmak için kullanılan değişkenin adını çıkartılmış bilgilerdir.

Ancak kalıp eşleştirmenin çalışma şekli, ayıklamanın kaynağına bağlıdır. Aşağıdakiler bölümleri, çıkarabileceğiniz iki temel bilgi kategorisini açıklar.

Eşleşen URI yolları, sorgu parametreleri, başlıklar, form parametreleri ve değişkenler

URI yolundan bilgi ayıklarken sorgu parametreleri, başlıklar, form parametreleri ve bir veya daha fazla değişken belirtmek için <Pattern> etiketini kullandığınız eşleştirmeye karar verdik. Örneğin, aşağıdaki politika örneğinde, URI yolu:

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

Bu örnekte, urirequest.pathSeg değişkeni ayarlanmıştır proxy.pathsuffix'de "/a/" işaretinden sonra gelen kısım ile aynı olacaktır. Örneğin, API Proxy'nizin /basepath/v1 olması gerekir . Gelen istekle http://myCo.com/basepath/v1/a/b adresine değişkeni "b" olarak ayarlanmış olmalıdır.

Birden çok kalıp belirtme

<Pattern> etiketlerine karşılık gelen eşleşme için birden fazla kalıp belirtebilirsiniz. Burada:

• Tüm kalıplar eşleşme için test edilir.
• Kalıplardan hiçbiri eşleşmezse politika hiçbir şey yapmaz ve değişkenler eşleşmez oluşturuldu.
• Birden fazla kalıp eşleşirse en uzun yol segmentlerine sahip kalıp çıkarma işlemi.
• Eşleşen iki kalıp aynı en uzun yol segmentlerine sahipse, ilk olarak bu politika ayıklama için kullanılır.

Sonraki örnekte, URI için eşleşen üç kalıp içeren bir politika oluşturursunuz. yol:

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

Temel yolu /basepath/v1 olan bir API Proxy'sinin gelen istek URL'sinin bağlantısı aşağıdaki biçimdedir:

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

Bu örnekte, ilk kalıp URI ile eşleşir ve urirequest.pathSeg değişkeni "b" olarak ayarlayın.

İstek URL'si:

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

...o zaman üçüncü kalıp eşleşir ve urirequest.pathSeg değişkeni "d" olarak ayarlanır.

Birden çok değişkenli kalıplar belirleme

Eşleşen kalıpta birden çok değişken belirtebilirsiniz. Örneğin, eşleştirme kalıbı:

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

Yine , gelen istek için temel yolu /basepath/v1 olan bir API Proxy'si düşünelim. URL:

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

...urirequest.pathSeg1 değişkeni "b" olarak ayarlanmış ve urirequest.pathSeg2 değişkeni "d" olarak ayarlanır.

Kalıpta birden fazla örneği eşleştirme

Kalıpları, aynı ada sahip bir öğenin birden fazla örneği olduğunda da eşleştirebilirsiniz. Örneğin, birden çok sorgu parametresi veya birden çok başlık içeren bir istekte bulunabilirsiniz. sahip olmanız gerekir. Aşağıdaki istek "w" adlı iki sorgu parametresi içeriyor:

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

ExtractDeğişkenler politikasında bu sorgu parametrelerine başvurmak için dizinleri kullanırsınız. sorgu parametresinin ilk örneği dizin 2'de, üçüncüsü olacak şekilde dizin 2'de dizin 3 vb. eklenebilir. Örneğin aşağıdaki politika, ikinci sorgu parametresinin değerini ayıklar adı "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 değişkeni: "2" değerine ayarlayın. İkinci sorgu parametresi istekten çıkarılırsa urirequest.secondW değişkeni boştur. İstekte aynı ada sahip birden fazla öğe olduğunda dizine ekleme işlevini kullanın.

Kalıpta özel karakterler kullanma

URI yollarını eşleştirirken "*" kullanabilirsiniz. ve "**" kalıpta joker karakterler varsa burada:

• "*" yolun herhangi bir segmentiyle eşleşir
• "**" Yolun birden çok segmentiyle eşleşir

Örneğin, <URIPath> öğesine aşağıda gösterildiği gibi kalıplar belirtirsiniz aşağıda bulabilirsiniz:

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

İlk kalıp, istekleri path ekleriyle eşleştirir (bundan sonra gelen URI yolunun "/a/b/c", "/a/foo/bar" vb. gibi) oluşturun. İkinci kalıp, istediğiniz sayıda yol ile eşleşir "/a/" karakterinden sonraki segmentler (ör. "/a/foo/bar/baz/c" ve "/a/b/c") ve "/a/foo/bar" yer alır.

Sorgu parametreleri, başlıklar ve form parametreleri için kalıp belirtirken "*" karakteri herhangi bir sayıda karakterle eşleşecek şekilde belirtir. Örneğin, bir üstbilgiyi eşleştirirken kalıbı şu şekildedir:

*;charset={encoding}

Bu kalıp, şu değerlerle eşleşir: "text/xml;charset=UTF-16" ve "application/xml;charset=ASCII".

ExtractVariables politikasına iletilen değer, "{", "%" kullanın karakteri ile karşılaşırsınız. Aşağıdaki örnekte "{" atlanır ve "}" karakterler kalıbın değerini belirtir, çünkü sorgunun değerinde düz karakterler olarak kullanılır parametresi:

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

Bu örnekte kalıp, "{user} Serkan" değeriyle eşleşir. "user" değerini değil Serdar" gibi.

Eşleşen JSON ve XML

JSON ve XML'den veri ayıklarken politikada bir veya daha fazla <Variable> etiketi belirtirsiniz. <Variable> etiketi ayıklanan bilgilerin depolandığı hedef değişkenin adı ve JsonPath (JSON) veya XPATH (XML) ile uzaklaştırın.

Politikadaki tüm <Variable> etiketleri değerlendirildiğinden, tek bir politikadan birden fazla değişkeni doldurabilirsiniz. Eğer <Variable> etiketi JSON veya XML'de geçerli bir alan olarak değerlendiriyorsanız, karşılık gelen değişken oluşturuldu.

Aşağıdaki örnekte, Yanıtın JSON gövdesi:

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

birden çok yerde aynı değişken

Ayarlanacak değişkenlerin adlarını seçerken dikkatli olun. Bu politika, çıkarma kalıbından sonuncuya taşıması gerekir. Politika, aynı değişkene birden çok basamak içeriyorsa, politikadaki son yazma değişkenin değerini belirler. (Bu, istediğinize karar verin.)

Örneğin, bir sorgu parametresinde iletilebilecek bir jeton değerini ayıklamak istiyorsunuz veya aşağıda gösterildiği gibi bir başlık içinde:

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

Hiçbir eşleşme olmadığında ne olacağını kontrol etme

Kalıp eşleşmezse karşılık gelen değişken oluşturulmaz. Bu nedenle, başka bir politika değişkene referansta bulunursa hataya neden olabilir.

Seçeneklerden biri, <IgnoreUnresolvedVariables> değerini yapılacak politikayı yapılandırmak için değişkene referans veren bir politikada true (doğru) herhangi bir çözümlenemeyen değişken boş dize olarak (boş):

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Öğe referansı

Öğe referansı, ExtractVariables'ın öğelerini ve özelliklerini açıklar politikası.

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

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

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<Source> öğe

(İsteğe bağlı) Ayrıştırılacak değişkeni belirtir. The value of <Source>, varsayılan olarak message değerine ayarlıdır. message değeri bağlama duyarlıdır. İstek akışında message, istek mesajını çözümler. İçinde bir yanıt akışı sağlarsa message, yanıt mesajına çözümlenir.

Bu politikayı genellikle bir istek veya yanıt mesajından bilgi ayıklamak için kullansanız da, bunu herhangi bir değişkenden bilgi ayıklamak için kullanabilir. Örneğin, Arkadaş Bitkiler projesinin AccessEntity politikası tarafından oluşturulan bir varlıktaki verilerden alınan bilgiler Hizmet tarafından iade edildi Çağrı politikası veya bir XML ya da JSON nesnesindeki bilgileri ayıklayın.
.
. <Source> çözümlenemezse veya mesaj olmayan bir türe çözümlenirse: politika yanıt vermez.

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

Özellikler

<VariablePrefix> öğe

(İsteğe bağlı) Değişken adının tamamı, <VariablePrefix>, bir nokta ve <Pattern> öğesi veya <Variable> öğesi. Örnek: myprefix.id, myprefix.dbncode veya myprefix.oauthtoken.

<VariablePrefix>myprefix</VariablePrefix>

Örneğin, ad değerinin "user" olduğunu varsayalım.

• <VariablePrefix> belirtilmezse çıkarılan değerler şunlardır: Parametresi user adlı bir değişkene atanmıştır.
• <VariablePrefix> önekim olarak belirtilirse çıkarılan değerleri, myprefix.user adlı bir değişkene atanır.

<IgnoreUnresolvedVariables> öğe

(İsteğe bağlı) Çözümlenemeyen değişkenleri boş dize olarak değerlendirmek için true olarak ayarlayın. (boş). Herhangi bir referans verildiğinde politikanın hata vermesini istiyorsanız false olarak ayarlayın değişkeni çözümlenemez.

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Bir XPath referansı <XMLPayload> içinde çözülmezse politika şu hata oluştu:

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

<URIPath> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değer çıkarır "istek kaynak mesajının proxy.pathsuffix'inden. Uygulanan yol kalıp, proxy.pathsuffix'tir. Bu dosya, API Proxy'sinin temel yolunu içermez. Eğer kaynak mesaj yanıt türünde bir mesaja çözümlenirse bu öğenin hiçbir etkisi olmaz.

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

Birden çok <Pattern> öğesi kullanılabilir:

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

Özellikler

<QueryParam> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değer çıkarır request kaynak mesajının belirtilen sorgu parametresinden seçilir. Öğe kaynak mesaj yanıt türünde bir mesaja çözümlenirse bu öğe hiçbir şey.

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

Birden çok sorgu parametresi aynı ada sahipse parametrelere referans vermek için dizinleri kullanın:

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

Özellikler

<Header> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değer çıkarır Belirtilen istek veya yanıt mesajının belirtilen HTTP başlığından. Birden fazla başlık aynı ada sahip olursa değerleri bir dizide depolanır.

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

Birden çok başlık aynı ada sahipse dizi:

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

Dizideki tüm üstbilgileri listelemek için şunu da yapabilirsiniz:

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

Özellikler

<FormParam> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değer çıkarır Belirtilen request veya response mesajının belirtilen form parametresinden. Form parametreleri yalnızca belirtilen iletinin Content-Type üstbilgisi şu olduğunda çıkarılabilir: application/x-www-form-urlencoded.

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

Özellikler

<Variable> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) değer ayıklanacak değişkenin adı.

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

Değişkenden iki değer çıkarmak için:

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

Özellikler

<JSONPayload> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değişken değerinin çıkarılacağı JSON biçimli mesaj. JSON ayıklama işlemi yalnızca iletinin Content-Type üstbilgisi application/json olduğunda gerçekleştirilir.

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

<JSONPayload>/<Variable> öğe

(JSONPayload öğesi içinde gerekli.) Çıkarılan değerin olduğu değişkeni belirtir atanır. Doldurmak için <Variable> öğesine birden fazla <Variable> etiketi ekleyebilirsiniz kullanabilirsiniz.

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

Özellikler

<JSONPayload>/<Variable>/<JSONPath> öğe

(JSONPayload:Variable öğesinde gereklidir.) Bir dosyayı ayıklamak için kullanılan JSON yolunu değeri JSON biçimli bir mesajdan alınır.

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

<XMLPayload> öğe

(İsteğe bağlı ancak daha fazla bilgi için aşağıdaki tabloda bulunan Durum satırına bakın.) Değişken değerinin çıkarılacağı XML biçimli mesaj. XML yükleri iletinin Content-Type üstbilgisi yalnızca iletinin - text/xml, application/xml, veya 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>

Özellikler

<XMLPayload>/<Namespaces> öğe

(İsteğe bağlı) XPath değerlendirmesinde kullanılacak ad alanını belirtir. Şunu kullanıyorsanız: ad alanlarını oluşturmak istiyorsanız, örneği inceleyelim.

<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 ifadelerinizde ad alanları kullanmıyorsanız <Namespaces> öğesi, aşağıdaki örnekte gösterildiği gibi:

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

Özellikler

<XMLPayload>/<Variable> öğe

(İsteğe bağlı) Çıkarılan değerin atanacağı değişkeni belirtir.

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

Özellikler

<XMLPayload>/<Variable>/<XPath> öğe

(XMLPayload:Variable öğesi içinde gereklidir.) Şu öğe için tanımlanan XPath'i belirtir: değişkenine eklenmelidir. Yalnızca XPath 1.0 ifadeleri desteklenir.

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

Ad alanı içeren örnek. XPath ifadelerinizde ad alanları kullanıyorsanız şunu bildirmeniz gerekir: <XMLPayload><Namespaces> bölümündeki ad alanları daha fazla bilgi edineceksiniz.

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

Hata referansı

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>

Şemalar

İlgili konular

Analiz API'si Özel analizler kullanarak mesaj içeriği

Değişkenler referansı