سیاست ExtractVariables

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

چی

خط مشی ExtractVariables محتوا را از یک درخواست یا پاسخ استخراج می کند و مقدار یک متغیر را برای آن محتوا تعیین می کند. می‌توانید هر بخشی از پیام را استخراج کنید، از جمله سرصفحه‌ها، مسیرهای URI، بارهای JSON/XML، پارامترهای فرم و پارامترهای پرس و جو. این خط‌مشی با اعمال یک الگوی متنی برای محتوای پیام کار می‌کند و پس از یافتن مطابقت، متغیری را با محتوای پیام مشخص شده تنظیم می‌کند.

در حالی که اغلب از این خط‌مشی برای استخراج اطلاعات از یک درخواست یا پیام پاسخ استفاده می‌کنید، می‌توانید از آن برای استخراج اطلاعات از منابع دیگر نیز استفاده کنید، از جمله موجودیت‌های ایجاد شده توسط خط‌مشی AccessEntity ، اشیاء XML یا اشیاء JSON.

پس از استخراج محتوای پیام مشخص شده، می توانید به عنوان بخشی از پردازش درخواست و پاسخ به متغیر در سایر خط مشی ها ارجاع دهید.

ویدیوها

ویدیوهای زیر را تماشا کنید تا درباره سیاست ExtractVariables بیشتر بدانید.

نمونه ها

این نمونه کد خط مشی نحوه استخراج متغیرها از انواع مصنوعات زیر را نشان می دهد:

<ExtractVariables name="ExtractVariables-1">
   <DisplayName>Extract a portion of the url path</DisplayName>
   <Source>request</Source>
   <URIPath>
      <Pattern ignoreCase="true">/accounts/{id}</Pattern>
   </URIPath>
   <VariablePrefix>urirequest</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="AssignPayload">
 <DisplayName>AssignPayload</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <IdExtractedFromURI>{urirequest.id}</IdExtractedFromURI>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="true" transport="http" type="request">newRequest</AssignTo>
</AssignMessage>

<ExtractVariables name="ExtractVariables-2">
   <DisplayName>Extract a value from a query parameter</DisplayName>
   <Source>request</Source>
   <QueryParam name="code">
      <Pattern ignoreCase="true">DBN{dbncode}</Pattern>
   </QueryParam>
   <VariablePrefix>queryinfo</VariablePrefix>
   <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetQP</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractQP>{queryinfo.dbncode}</ExtractQP>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name="ExtractVariables-2">
   <DisplayName>Extract a value from a query parameter</DisplayName>
   <Source>request</Source>
   <QueryParam name="w">
      <Pattern ignoreCase="true">{firstWeather}</Pattern>
   </QueryParam>
   <QueryParam name="w.2">
     <Pattern ignoreCase="true">{secondWeather}</Pattern>
   </QueryParam>
   <VariablePrefix>queryinfo</VariablePrefix>
 <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetQP</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractQP1>{queryinfo.firstWeather}</ExtractQP1>
    <ExtractQP2>{queryinfo.secondWeather}</ExtractQP2>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name='ExtractVariable-OauthToken'>
  <Source>request</Source>
  <Header name="Authorization">
    <Pattern ignoreCase="false">Bearer {oauthtoken}</Pattern>
  </Header>
  <VariablePrefix>clientrequest</VariablePrefix>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
 <DisplayName>GetHeader</DisplayName>
  <Set>
   <Payload contentType="text/xml">
    <ExtractHeader>{clientrequest.oauthtoken}</ExtractHeader>
   </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

<ExtractVariables name="ExtractVariables-3">
   <Source>response</Source>
   <JSONPayload>
      <Variable name="latitude" type="float">
         <JSONPath>$.results[0].geometry.location.lat</JSONPath>
      </Variable>
      <Variable name="longitude" type="float">
         <JSONPath>$.results[0].geometry.location.lng</JSONPath>
      </Variable>
   </JSONPayload>
   <VariablePrefix>geocoderesponse</VariablePrefix>
</ExtractVariables>

{
  "results": [{
    "geometry": {
      "location": {
        "lat": 37.42291810,
        "lng": -122.08542120
      },
      "location_type": "ROOFTOP",
      "viewport": {
        "northeast": {
          "lat": 37.42426708029149,
          "lng": -122.0840722197085
        },
        "southwest": {
          "lat": 37.42156911970850,
          "lng": -122.0867701802915
        }
      }
    }
  }]
}

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
  <DisplayName>GetJSONVar</DisplayName>
  <Add>
    <Headers>
      <Header name="latitude">{geocoderesponse.latitude}</Header>
    </Headers>
  </Add> 
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="response"/> 
</AssignMessage>

<ExtractVariables name="ExtractVariables-4">
   <Source>response</Source>
   <XMLPayload>
      <Namespaces>
         <Namespace prefix="dir">urn:43BFF88D-D204-4427-B6BA-140AF393142F</Namespace>
      </Namespaces>
      <Variable name="travelmode" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/@mode</XPath>
      </Variable>
      <Variable name="duration" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/dir:duration/dir:value</XPath>
      </Variable>
      <Variable name="timeunit" type="string">
         <XPath>/dir:Directions/dir:route/dir:leg/dir:step/dir:duration/dir:text</XPath>
      </Variable>
   </XMLPayload>
   <VariablePrefix>directionsresponse</VariablePrefix>
</ExtractVariables>

<Directions xmlns="urn:43BFF88D-D204-4427-B6BA-140AF393142F">
   <status>OK</status>
   <route>
      <summary>I-40 W</summary>
      <leg>
         <step mode="DRIVING">
            <start_location>
               <lat>41.8507300</lat>
               <lng>-87.6512600</lng>
            </start_location>
            <end_location>
               <lat>41.8525800</lat>
               <lng>-87.6514100</lng>
            </end_location>
            <duration>
                <value>19</value>
                <text>minutes</text>
            </duration>
         </step>
      </leg>
   </route>
</Directions>

<AssignMessage async="false" continueOnError="false" enabled="true" name="GetURIPath">
  <DisplayName>GetXMLVar</DisplayName>
  <Add>
    <Headers>
      <Header name="tmode">{directionsresponse.travelmode}</Header>
    </Headers>
  </Add>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

درباره سیاست ExtractVariables

توسعه‌دهندگان API پروکسی‌های API را می‌سازند که بر اساس محتوای پیام‌ها، از جمله سرصفحه‌ها، مسیرهای URI، بارهای پرداخت و پارامترهای پرس و جو، رفتار متفاوتی دارند. اغلب، پروکسی بخشی از این محتوا را برای استفاده در یک دستور شرط استخراج می کند. برای این کار از خط مشی ExtractVariables استفاده کنید.

هنگام تعریف خط مشی ExtractVariables، می توانید انتخاب کنید:

• نام متغیرهایی که قرار است تنظیم شوند
• منبع متغیرها
• چند متغیر استخراج و تنظیم شود

هنگام اجرا، خط مشی یک الگوی متنی را به محتوا اعمال می کند و پس از یافتن مطابقت، مقدار متغیر تعیین شده را با محتوا تنظیم می کند. سپس سایر خط‌مشی‌ها و کدها می‌توانند آن متغیرها را برای فعال کردن رفتار پویا یا ارسال داده‌های تجاری به Edge API Analytics مصرف کنند.

برای اینکه ببینید چگونه می‌توان از ExtractVariables برای ساخت گزارش‌های Analytics مبتنی بر محتوا استفاده کرد، به تحلیل محتوای پیام API با استفاده از تجزیه و تحلیل سفارشی مراجعه کنید.

دامنه

متغیرهای تنظیم شده با خط مشی ExtractVariables دارای دامنه جهانی هستند. یعنی پس از اینکه سیاست ExtractVariables یک متغیر جدید را تعریف کرد، می توانید از هر خط مشی یا کدی در هر مرحله از جریان (که بعد از سیاست ExtractVariables اجرا می شود) به آن متغیر دسترسی داشته باشید. این شامل:

• PreFlow: ProxyEndpoint و TargetEndpoint (درخواست و پاسخ)
• PostFlow: ProxyEndpoint و TargetEndpoint (درخواست و پاسخ)
• PostClientFlow: ProxyEndpoint (فقط پاسخ، با استفاده از خط مشی ثبت پیام )
• جریان خطا

درباره تطبیق و ایجاد متغیر

خط مشی ExtractVariables اطلاعات را از یک درخواست یا پاسخ استخراج می کند و آن اطلاعات را در یک متغیر می نویسد. برای هر نوع اطلاعاتی که می توانید استخراج کنید، مانند مسیر URI یا داده های XML، الگوی مطابقت و نام متغیر مورد استفاده برای نگهداری اطلاعات استخراج شده را مشخص می کنید.

با این حال، نحوه عملکرد تطبیق الگو به منبع استخراج بستگی دارد. بخش‌های زیر دو دسته اصلی اطلاعاتی را که می‌توانید استخراج کنید، توضیح می‌دهد.

تطبیق مسیرهای URI، پارامترهای پرس و جو، هدرها، پارامترهای فرم و متغیرها

هنگام استخراج اطلاعات از مسیر URI، پارامترهای پرس و جو، سرصفحه ها، پارامترهای فرم و متغیرها، از تگ <Pattern> برای تعیین یک یا چند الگو برای مطابقت استفاده می کنید. به عنوان مثال، مثال خط مشی زیر یک الگوی منطبق برای مسیر URI را نشان می دهد:

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

در این مثال، متغیر urirequest.pathSeg روی هر چیزی که پس از "/a/" در پسوند proxy.path ظاهر می شود، تنظیم می شود. برای مثال، فرض کنید مسیر پایه برای پروکسی 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، از ایندکس ها استفاده می کنید، که در آن اولین نمونه از پارامتر query فاقد ایندکس است، نمونه دوم در شاخص 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" تنظیم شده است. اگر دومین پارامتر query از درخواست حذف شود، متغیر urirequest.secondW خالی است. هر زمان که چندین مورد با نام یکسان در درخواست وجود داشت از نمایه سازی استفاده کنید.

استفاده از کاراکترهای خاص در الگو

هنگام تطبیق مسیرهای URI، می توانید از کاراکترهای عام "*" و "**" در الگو استفاده کنید، جایی که:

• "*" با هر بخش از مسیر مطابقت دارد
• "**" با چندین بخش از مسیر مطابقت دارد

به عنوان مثال، الگوهایی را برای عنصر <URIPath> مطابق شکل زیر مشخص می کنید:

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

الگوی اول درخواست‌ها را با پسوندهای مسیر (بخشی از مسیر URI که مسیر پایه را دنبال می‌کند) مطابقت می‌دهد، مانند «/a/b/c»، «/a/foo/bar»، و غیره. الگوی دوم با هر تعداد از بخش‌های مسیر پس از آن مطابقت دارد. «/a/»، مانند «/a/foo/bar/baz/c»، و همچنین «/a/b/c» و «/a/foo/bar».

هنگام تعیین الگوها برای پارامترهای پرس و جو، سرصفحه ها و پارامترهای فرم، کاراکتر "*" تعیین می کند که با هر تعداد کاراکتر مطابقت داشته باشد. به عنوان مثال، هنگام تطبیق یک هدر، الگو را به صورت زیر مشخص کنید:

*;charset={رمزگذاری}

این الگو با مقادیر "text/xml;charset=UTF-16" و "application/xml;charset=ASCII" مطابقت دارد.

اگر مقدار ارسال شده به خط مشی ExtractVariables حاوی یک کاراکتر خاص مانند "{" باشد، از نویسه "%" برای فرار از آن استفاده کنید. مثال زیر از کاراکترهای "{" و "}" در الگو فرار می کند زیرا آنها به عنوان کاراکترهای تحت اللفظی در مقدار پارامتر query استفاده می شوند:

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

نوشتن روی یک متغیر در چندین مکان

در انتخاب نام متغیرها برای تنظیم دقت کنید. این خط مشی به صورت متوالی از اولین الگوی استخراج تا آخرین الگو اجرا می شود. اگر خط مشی یک مقدار را برای یک متغیر از چندین مکان بنویسد، آخرین نوشتن در خط مشی مقدار متغیر را تعیین می کند. (ممکن است این همان چیزی باشد که شما می خواهید.)

به عنوان مثال، شما می خواهید یک مقدار توکن استخراج کنید که می تواند در یک پارامتر query یا در یک هدر ارسال شود، همانطور که در زیر نشان داده شده است:

<!-- 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 در یک خط مشی تنظیم کنید که به متغیر ارجاع می دهد تا خط مشی را پیکربندی کند تا هر متغیر غیرقابل حلی را به عنوان یک رشته خالی (تهی) در نظر بگیرد:

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

مرجع عنصر

مرجع عنصر عناصر و ویژگی های خط مشی ExtractVariables را توصیف می کند.

<ExtractVariables async="false" continueOnError="false" enabled="true" name="Extract-Variables-1">
   <DisplayName>Extract Variables 1</DisplayName>
   <Source clearPayload="true|false">request</Source>
   <VariablePrefix>myprefix</VariablePrefix>
   <IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>
   <URIPath>
      <Pattern ignoreCase="false">/accounts/{id}</Pattern>
   </URIPath>
   <QueryParam name="code">
      <Pattern ignoreCase="true">DBN{dbncode}</Pattern>
   </QueryParam>
   <Header name="Authorization">
      <Pattern ignoreCase="false">Bearer {oauthtoken}</Pattern>
   </Header>
   <FormParam name="greeting">
      <Pattern>hello {user}</Pattern>
   </FormParam>
   <Variable name="request.content">
       <Pattern>hello {user}</Pattern>
   </Variable>
   <JSONPayload>
      <Variable name="name">
         <JSONPath>{example}</JSONPath>
      </Variable>
   </JSONPayload>
   <XMLPayload stopPayloadProcessing="false">
      <Namespaces/>
      <Variable name="name" type="boolean">
         <XPath>/test/example</XPath>
      </Variable>
   </XMLPayload>
</ExtractVariables>

ویژگی های <ExtractVariables>

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

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <منبع>

(اختیاری) متغیری را که باید تجزیه شود را مشخص می کند. مقدار <Source> به طور پیش فرض برای message است. مقدار message به زمینه حساس است. در یک جریان درخواست، message به پیام درخواست حل می شود. در یک جریان پاسخ، message به پیام پاسخ حل می شود.

در حالی که اغلب از این خط مشی برای استخراج اطلاعات از یک درخواست یا پیام پاسخ استفاده می کنید، می توانید از آن برای استخراج اطلاعات از هر متغیری استفاده کنید. برای مثال، می‌توانید از آن برای استخراج اطلاعات از یک موجودیت ایجاد شده توسط خط‌مشی AccessEntity ، از داده‌های بازگردانده شده توسط خط‌مشی Service Callout ، یا استخراج اطلاعات از یک شی XML یا JSON استفاده کنید.

اگر <Source> قابل حل نباشد، یا به یک نوع غیر پیام حل شود، خط مشی پاسخ نمی دهد.

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

صفات

عنصر <VariablePrefix>

(اختیاری) نام کامل متغیر با پیوستن به <VariablePrefix> ، یک نقطه، و نامی که در {پرانتزهای فرفری} در عنصر <Pattern> یا عنصر <Variable> تعریف می‌کنید ایجاد می‌شود. به عنوان مثال: myprefix.id ، myprefix.dbncode ، یا myprefix.oauthtoken.

<VariablePrefix>myprefix</VariablePrefix>

به عنوان مثال، فرض کنید مقدار نام "user" باشد.

• اگر <VariablePrefix> مشخص نشده باشد، مقادیر استخراج شده به متغیری به نام user اختصاص داده می شود.
• اگر <VariablePrefix> به عنوان myprefix مشخص شود، مقادیر استخراج شده به متغیری به نام myprefix.user اختصاص داده می شود.

عنصر <IgnoreUnresolvedVariables>

(اختیاری) روی true تنظیم کنید تا هر متغیر غیرقابل حلی را به عنوان یک رشته خالی (تهی) در نظر بگیرید. اگر می‌خواهید خط‌مشی زمانی که متغیر ارجاع‌شده غیرقابل حل است، خطایی ایجاد کند، آن را روی false تنظیم کنید.

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

اگر مرجع XPath در <XMLPayload> حل نشده باشد، خط مشی خطای زیر را ایجاد می کند:

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

عنصر <URIPath>

(اختیاری است، اما برای اطلاعات بیشتر به ردیف Presence در جدول زیر مراجعه کنید.) مقداری را از پسوند proxy.path یک پیام منبع درخواست استخراج می کند. مسیر اعمال شده به الگو، پسوند proxy.path است که شامل مسیر پایه برای پروکسی API نمی شود. اگر پیام منبع به یک نوع پیام پاسخ داده شود، این عنصر هیچ کاری انجام نمی دهد.

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

امکان استفاده از چندین عنصر <Pattern> وجود دارد:

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

صفات

عنصر <QueryParam>

(اختیاری است، اما برای اطلاعات بیشتر به ردیف حضور در جدول زیر مراجعه کنید.) مقداری را از پارامتر پرس و جوی مشخص شده پیام منبع درخواست استخراج می کند. اگر پیام منبع به یک نوع پیام پاسخ داده شود، این عنصر هیچ کاری انجام نمی دهد.

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

اگر چندین پارامتر پرس و جو دارای نام یکسانی هستند، برای ارجاع به پارامترها از شاخص ها استفاده کنید:

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

صفات

عنصر <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>

(اختیاری است، اما برای اطلاعات بیشتر به ردیف Presence در جدول زیر مراجعه کنید.) نام متغیری را مشخص می کند که از آن مقداری استخراج شود.

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

برای استخراج دو مقدار از متغیر:

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

صفات

عنصر <JSONPayload>

(اختیاری است، اما برای اطلاعات بیشتر به ردیف Presence در جدول زیر مراجعه کنید.) پیامی با فرمت JSON را مشخص می کند که مقدار متغیر از آن استخراج می شود. استخراج JSON فقط زمانی انجام می‌شود که هدر نوع محتوای پیام application/json باشد.

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

عنصر <JSONPayload>/<Variable>

(در عنصر JSONPayload لازم است.) متغیری را که در آن مقدار استخراج شده اختصاص داده شده است، مشخص می کند. می توانید چندین تگ <Variable> را در عنصر <JSONPayload> اضافه کنید تا چندین متغیر را پر کنید.

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

صفات

عنصر <JSONPayload>/<متغیر>/<JSONPath>

(در عنصر JSONPayload:Variable لازم است.) مسیر JSON مورد استفاده برای استخراج یک مقدار از یک پیام با فرمت JSON را مشخص می کند.

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

عنصر <XMLPayload>

(اختیاری است، اما برای اطلاعات بیشتر به ردیف Presence در جدول زیر مراجعه کنید.) پیام با قالب 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>

مرجع خطا

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

Runtime errors

These errors can occur when the policy executes.

Deployment errors

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

Fault variables

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

Example error response

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

Example fault rule

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

طرحواره ها

موضوعات مرتبط

محتوای پیام API را با استفاده از تجزیه و تحلیل سفارشی تجزیه و تحلیل کنید

مرجع متغیرها