سياسة استخراج المتغيرات

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

المزايا

تستخرج سياسة RecoveryVariables المحتوى من طلب أو استجابة وتحدّد قيمة متغير لذلك المحتوى. يمكنك استخراج أي جزء من الرسالة، بما في ذلك العناوين ومسارات معرّف الموارد المنتظم (URI) وحمولات JSON/XML ونموذج ومعلمات طلب البحث. تعمل السياسة من خلال تطبيق نمط نصي على الرسالة المحتوى، وعند العثور على تطابق، يتم تعيين متغير بمحتوى الرسالة المحدد.

وعلى الرغم من أنّك تستخدم هذه السياسة عادةً لاستخراج المعلومات من طلب أو رسالة ردّ، يمكنك يمكنك أيضًا استخدامها لاستخراج معلومات من مصادر أخرى، بما في ذلك الكيانات التي أنشأها سياسة AccessEntity، كائنات XML أو كائنات JSON.

وبعد استخراج محتوى الرسالة المحدّد، يمكنك الإشارة إلى المتغيّر في السياسات كجزء من معالجة الطلب والاستجابة.

الفيديوهات

لمعرفة مزيد من المعلومات حول سياسة استخراج المتغيّرات، يمكنك مشاهدة الفيديوهات التالية.

نماذج

توضح نماذج التعليمات البرمجية للسياسة هذه كيفية استخراج المتغيرات من أنواع الأدوات:

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

لمحة عن سياسة استخراج المتغيّرات

ينشئ مطورو واجهة برمجة التطبيقات خوادم وكيلة لواجهة برمجة التطبيقات تتصرف بشكل مختلف حسب محتوى الرسائل، بما في ذلك العناوين ومسارات معرّف الموارد المنتظم (URI) والحمولات ومَعلمات طلب البحث. غالبًا ما يستخرج الخادم الوكيل بعض من هذا المحتوى للاستخدام في بيان شرط. يمكنك استخدام سياسة استخراج المتغيّرات لتنفيذ هذا.

عند تحديد سياسة استخراج المتغيّرات، يمكنك اختيار ما يلي:

• أسماء المتغيّرات المُراد ضبطها
• مصدر المتغيّرات
• عدد المتغيّرات المطلوب استخراجها وضبطها

وعند تنفيذها، تطبّق السياسة نمطًا نصيًا على المحتوى، وتضبط عند العثور على تطابق قيمة المتغير المعين مع المحتوى. حينئذ يمكن أن تستهلك السياسات والرموز الأخرى هذه المتغيرات لتفعيل السلوك الديناميكي أو إرسال بيانات النشاط التجاري إلى Edge API Analytics.

لمعرفة كيفية استخدام المتغيّرات القابلة للاستخراج لإنشاء تقارير "إحصاءات Google" المستندة إلى المحتوى، يُرجى مراجعة التحليل محتوى رسائل واجهة برمجة التطبيقات باستخدام إحصاءات مخصّصة

النطاق

إنّ المتغيرات التي يتم إعدادها باستخدام سياسة PermissionVariables لها نطاق عالمي. أي، بعد تُحدِّد سياسة OutputVariables متغيّرًا جديدًا، ويمكنك الوصول إلى ذلك المتغيّر من أي سياسة أو الرمز البرمجي في أي مرحلة من مراحل التدفق (يتم تنفيذه بعد سياسة استخراج المتغيّرات). هذا النمط تتضمن ما يلي:

• PreFlow: ProxyEndpoint وTargetEndpoint (الطلب والردّ)
• PostFlow: ProxyEndpoint وTargetEndpoint (الطلب والردّ)
• PostClientFlow: ProxyEndpoint (الرد فقط، باستخدام سياسة تسجيل الرسائل)
• مسارات الأخطاء

لمحة عن المطابقة وإنشاء المتغيّرات

تستخرج سياسة OutputVariables المعلومات من طلب أو ردّ وتكتب ما يلي: المعلومات إلى متغير. لكل نوع من المعلومات التي يمكنك استخراجها، مثل مسار 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 على أي شيء يظهر في publisher.pathsuffix بعد "/a/". على سبيل المثال، افترض أن المسار الأساسي الخادم الوكيل لواجهة برمجة التطبيقات هو /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>

افترض، بالنسبة إلى خادم وكيل لواجهة برمجة التطبيقات مع مسار أساسي /basepath/v1، يتضمن عنوان URL للطلب الوارد إلى الخادم الوكيل لواجهة برمجة التطبيقات بهذا النموذج:

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>

افتراض أنّ هناك خادم وكيل لواجهة برمجة التطبيقات مع المسار الأساسي /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

للإشارة إلى معلَمات طلب البحث هذه في سياسة استخراج المتغيّرات، يمكنك استخدام الفهارس، حيث يشير لا يحتوي المثيل الأول لمعلمة طلب البحث على أي فهرس، والثاني في الفهرس 2، والثالث في الفهرس 3 وما إلى ذلك. على سبيل المثال، تستخرج السياسة التالية قيمة معلَمة طلب البحث الثانية باسم "w" في الطلب:

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

المتغير urirequest.secondW هو تم تعيينها على "2". إذا تم حذف معلَمة طلب البحث الثانية من الطلب، يتم تغيير المتغير urirequest.secondW فارغ. استخدِم الفهرسة في أي وقت يتضمّن الطلب عدة عناصر تحمل الاسم نفسه.

استخدام رموز خاصة في النمط

عند مطابقة مسارات معرف الموارد المنتظم (URI)، يمكنك استخدام الرمز "*" و"**" أحرف البدل في النمط، حيث:

• "*" تتطابق مع أي جزء من المسار
• "**" تتطابق مع أجزاء متعددة من المسار

على سبيل المثال، يمكنك تحديد أنماط للعنصر <URIPath> كما هو موضَّح. أدناه:

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

يتطابق النمط الأول مع الطلبات ذات المسارات (الجزء من مسار URI الذي يلي المسار الأساسي) مثل "/a/b/c" و"/a/foo/bar" وما إلى ذلك. ويتطابق النمط الثاني مع أي عدد من المسارات المقاطع بعد "/a/"، مثل "/a/foo/bar/baz/c" وكذلك "/a/b/c" و"/a/foo/bar".

عند تحديد أنماط لمعلمات طلب البحث والعناوين ومعلمات النموذج، يمكن للحرف "*" لمطابقة أي عدد من الأحرف. على سبيل المثال، عند مطابقة عنوان، حدد النمط على النحو التالي:

*;charset={encoding}

يتطابق هذا النمط مع القيم "text/xml;charset=UTF-16" أو "application/xml;charset=ASCII".

إذا كانت القيمة التي تم تمريرها إلى سياسة PermissionVariables تحتوي على حرف خاص، مثل "{"، استخدِم علامة "%" شخصية للهروب منها. يتخطى المثال التالي "{" و "}" الأحرف في النمط لأنها تُستخدم كأحرف حرفية في قيمة الاستعلام :

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

في هذا المثال، يتطابق النمط مع القيمة "{user} سيف" ولكن ليس قيمة "المستخدم ستيف".

تنسيق JSON وXML متطابقان

عند استخراج البيانات من JSON وXML، يمكنك تحديد علامة <Variable> واحدة أو أكثر في السياسة. تحدد العلامة <Variable> اسم متغير الوجهة حيث يتم تخزين المعلومات المستخرجة، وحقل JsonPath (JSON) أو XPATH (XML) إلى المعلومات المستخرجة.

جميع علامات <Variable> في السياسة بحيث يمكنك تعبئة متغيرات متعددة من سياسة واحدة. في حال حذف فإن العلامة <Variable> لا إلى حقل صالح في JSON أو XML، فلن يكون المتغير المتجاوب إنشاء.

يوضح المثال التالي سياسة استخراج المتغيّرات التي تملأ متغيّرَين من نص استجابة JSON:

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

الكتابة إلى نفس المتغير في عدة أماكن

انتبه عند اختيار أسماء المتغيرات المطلوب ضبطها. يتم تنفيذ السياسة بشكل تسلسلي من نمط الاستخراج الأول إلى الأخير. وإذا كتبت السياسة قيمة للمتغير نفسه من أماكن متعددة، فإن آخر عملية كتابة في السياسة تحدد قيمة المتغير. (قد تكون هذه ما تريد.)

على سبيل المثال، تريد استخراج قيمة رمز مميّز يمكن ضبطها في مَعلمة طلب بحث. أو في أحد العناوين، كما هو موضّح أدناه:

<!-- If token only in query param, the query param determines the value. 
     If token is found in both the query param and header, header sets value. -->
<QueryParam name="token">
  <Pattern ignoreCase="true">{tokenValue}</Pattern>
</QueryParam>
 
<!-- Overwrite tokenValue even if it was found in query parameter. -->
<Header name="Token">
  <Pattern ignoreCase="true">{tokenValue}</Pattern>
</Header>

التحكم في ما يحدث في حال عدم حدوث أي تطابق

إذا لم يتطابق النمط، فلن يتم إنشاء المتغير المتجاوب. لذلك، إذا فإن سياسة أخرى تشير إلى المتغير، فيمكن أن يتسبب ذلك في حدوث خطأ.

أحد الخيارات هي ضبط <IgnoreUnresolvedVariables> على true في سياسة تشير إلى المتغير لضبط السياسة لمعالجة أي متغير غير قابل للتحليل كسلسلة فارغة (فارغ):

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

مرجع العنصر

يصف مرجع العنصر عناصر استخراجات Variables وسماتها .

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

<ExtractVariables> السمات

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

يصف الجدول التالي السمات المشتركة بين جميع العناصر الرئيسية للسياسة:

<DisplayName> عنصر

استخدِمه مع السمة name لتصنيف السياسة في إدارة خادم وكيل لواجهة المستخدم باسم مختلف بلغة طبيعية.

<DisplayName>Policy Display Name</DisplayName>

<Source> عنصر

(اختياري) تحدِّد هذه السياسة المتغيّر المطلوب تحليله. قيمة يتم ضبط <Source> تلقائيًا على message. قيمة message حساسة للسياق. خلال عملية الطلب، تتم معالجة message مع رسالة الطلب. ضِمن مسار الرد، تتم معالجة message مع رسالة الرد.

وعلى الرغم من أنّك تستخدم هذه السياسة عادةً لاستخراج المعلومات من طلب أو رسالة ردّ، يمكنك يمكنك استخدامه لاستخراج المعلومات من أي متغير. على سبيل المثال، يمكنك استخدامها لاستخراج معلومات من كيان تم إنشاؤه بموجب سياسة AccessEntity، من البيانات التي تم إرجاعها بواسطة الخدمة سياسة وسيلة الشرح أو استخراج المعلومات من كائن 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> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). لاستخراج قيمة من الوكيل.pathsuffix لرسالة مصدر الطلب. المسار المطبق على يكون النمط هوproxy.pathsuffix، الذي لا يتضمن المسار الأساسي لخادم وكيل واجهة برمجة التطبيقات. في حال حذف يؤدي تحويل رسالة المصدر إلى نوع الرسالة response، وعندئذٍ لا يفعل هذا العنصر أي شيء.

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

ومن الممكن استخدام عناصر <Pattern> متعددة:

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

السمات

<QueryParam> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). لاستخراج قيمة من معلَمة طلب البحث المحدّدة لرسالة مصدر request. إذا كانت تتم مطابقة رسالة المصدر إلى نوع الرسالة response، فسيعمل هذا العنصر على لا شيء.

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

إذا كانت معلَمات طلب بحث متعددة تحمل الاسم نفسه، استخدِم الفهارس للإشارة إلى المَعلمات:

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

السمات

<Header> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). لاستخراج قيمة من عنوان HTTP المحدّد لرسالة request أو response المحدّدة. إذا كانت العناوين المتعددة تحتوي نفس الاسم، يتم تخزين قيمها في صفيف.

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

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). لاستخراج قيمة من مَعلمة النموذج المحدّدة لرسالة request أو response المحدّدة. معلمات النموذج لا يمكن استخراجه إلا عندما يكون عنوان Content-Type للرسالة المحدّدة هو application/x-www-form-urlencoded

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

السمات

<Variable> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). تحدد اسم المتغير المطلوب استخراج قيمة منه.

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

لاستخراج قيمتَين من المتغيّر:

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

السمات

<JSONPayload> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). تحدد رسالة بتنسيق JSON التي سيتم استخراج قيمة المتغيّر منها. JSON يتم تنفيذ الاستخراج فقط عندما يكون الرأس Content-Type في الرسالة هو application/json.

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

<JSONPayload>/<Variable> عنصر

(مطلوب ضمن عنصر JSONPayload). تحدِّد هذه السياسة المتغيّر الذي يتم فيه تحديد القيمة المستخرجة. المهام المطلوبة. يمكنك تضمين علامات <Variable> متعدّدة في العنصر <Variable> لتعبئة متغيرات متعددة.

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

السمات

<JSONPayload>/<Variable>/<JSONPath> عنصر

(مطلوب ضمن العنصر JSONPayload:Variable). تُحدِّد مسار JSON المستخدَم لاستخراج من رسالة بتنسيق JSON.

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

<XMLPayload> عنصر

(اختياري، ولكن يمكنك الاطّلاع على صف التواجد في الجدول أدناه للحصول على مزيد من المعلومات). تحدد رسالة بتنسيق XML التي سيتم استخراج قيمة المتغيّر منها. حمولات XML يتم استخراجها فقط عند استخدام عنوان Content-Type للرسالة text/xml، application/xml، أو application/*+xml.

<XMLPayload stopPayloadProcessing="false">
  <Namespaces>
     <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     <Namespace prefix="gmail">http://mail.google.com</Namespace>
  </Namespaces>
  <Variable name="name" type="boolean">
     <XPath>/apigee:test/apigee:example</XPath>
  </Variable>
</XMLPayload>

السمات

<XMLPayload>/<Namespaces> عنصر

(اختياري) تحدّد مساحة الاسم المراد استخدامها في تقييم XPath. إذا كنت تستخدم في تعبيرات XPath، يجب إعلان مساحات الاسم هنا، كما هو موضح في المثال التالي.

<XMLPayload stopPayloadProcessing="false">
  <Namespaces>
     <Namespace prefix="apigee">http://www.apigee.com</Namespace>
     <Namespace prefix="gmail">http://mail.google.com</Namespace>
  </Namespaces>
  <Variable name="legName" type="string">
    <XPath>/apigee:Directions/apigee:route/apigee:leg/apigee:name</XPath>
  </Variable>
</XMLPayload>

إذا كنت لا تستخدم مساحات الاسم في تعبيرات XPath، يمكنك حذف عنصر <Namespaces>، كما يبيِّن المثال التالي:

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

السمات

<XMLPayload>/<Variable> عنصر

(اختياري) تحدِّد هذه السياسة المتغيّر الذي سيتم تخصيص القيمة المستخرجة له.

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

السمات

<XMLPayload>/<Variable>/<XPath> عنصر

(مطلوب ضمن عنصر XMLPayload:Variable). تحدد مسار XPath المحدد المتغير. ويمكن استخدام تعبيرات XPath 1.0 فقط.

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

مثال مع مساحة اسم إذا كنت تستخدم مساحات الاسم في تعبيرات XPath، يجب تعريف مساحات الاسم في القسم <XMLPayload><Namespaces> من السياسة.

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

مرجع الخطأ

يصف هذا القسم رموز الخطأ ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تم ضبطها من خلال Edge عندما تؤدي هذه السياسة إلى ظهور خطأ. من المهم معرفة هذه المعلومات إذا كنت تضع قواعد خطأ التعامل مع الأخطاء. للحصول على مزيد من المعلومات، يمكنك الاطّلاع على ما تحتاج إلى معرفته حول أخطاء السياسة والتعامل مع المعالجة والأخطاء.

أخطاء بيئة التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة.

أخطاء النشر

يمكن أن تحدث هذه الأخطاء عند نشر خادم وكيل يحتوي على هذه السياسة.

متغيّرات الأخطاء

يتم ضبط هذه المتغيّرات عندما تؤدي هذه السياسة إلى ظهور خطأ في وقت التشغيل. لمزيد من المعلومات يمكنك الاطّلاع على ما تحتاج إلى معرفتها حول أخطاء السياسة.

مثال على استجابة الخطأ

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

مثال على قاعدة الخطأ

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

المخططات

مواضيع ذات صلة

واجهة برمجة التطبيقات الخاصة بالتحليل محتوى الرسائل باستخدام الإحصاءات المخصّصة

مرجع المتغيّرات