سياسة LookupCache

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

تحدِّد هذه السياسة طريقة استرداد القيم المخزَّنة مؤقتًا في وقت التشغيل.

تم تصميم هذه السياسة للاستخدام في التخزين المؤقت قصير المدى للأغراض العامة. تُستخدم في جنبًا إلى جنب مع ملء سياسة ذاكرة التخزين المؤقت (لكتابة الإدخالات) وسياسة إلغاء صلاحية ذاكرة التخزين المؤقت (لإلغاء الإدخالات)

لتخزين استجابات موارد الخلفية مؤقتًا، يُرجى الاطّلاع على سياسة ذاكرة التخزين المؤقت للردود.

مرجع العنصر

في ما يلي قائمة بالعناصر التي يمكنك ضبطها وفقًا لهذه السياسة.

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

يتم تضمين ذاكرة تخزين مؤقت مشتركة تلقائيًا. لاستخدام ذاكرة التخزين المؤقت المشتركة، احذف العنصر <CacheResource> في إعدادات السياسة هذه.

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

&lt;LookupCache&gt; السمات

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

السمة الوصف تلقائي التواجد في المنزل
name

الاسم الداخلي للسياسة. يمكن لقيمة السمة name أن تحتوي على أحرف وأرقام ومسافات وواصلات وشرطات سفلية ونقاط. لا يمكن لهذه القيمة يتجاوز 255 حرفًا.

يمكنك، إذا أردت، استخدام العنصر <DisplayName> لتصنيف السياسة محرر الخادم الوكيل لواجهة مستخدم الإدارة باسم مختلف بلغة طبيعية.

لا ينطبق مطلوب
continueOnError

اضبط القيمة على false لعرض رسالة خطأ عند تعذُّر تنفيذ سياسة. هذا متوقّع السلوك في معظم السياسات.

يمكنك ضبط القيمة على true لمواصلة تنفيذ المسار حتى بعد تطبيق إحدى السياسات. فشل.

خطأ اختياري
enabled

اضبط القيمة على true لفرض السياسة.

اضبط القيمة على false من أجل إيقاف السياسة. لن تكون السياسة ويتم فرضها حتى لو ظلت مرتبطة بتدفق.

صحيح اختياري
async

تم إيقاف هذه السمة نهائيًا.

خطأ منهي العمل به

&lt;DisplayName&gt; عنصر

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

<DisplayName>Policy Display Name</DisplayName>
تلقائي

لا ينطبق

إذا لم تستخدم هذا العنصر، سيتم ضبط قيمة السمة name للسياسة على النحو التالي: استخدام البيانات المختلفة.

التواجد في المنزل اختياري
النوع سلسلة

&lt;AssignTo&gt; عنصر

تُحدِّد المتغيّر الذي يتم فيه تعيين إدخال ذاكرة التخزين المؤقت بعد استرداده من ذاكرة التخزين المؤقت. يجب أن يكون المتغيّر قابلاً للكتابة. إذا لم يسترد بحث ذاكرة التخزين المؤقت قيمة، فسيبدأ المتغير لن يتم تعيينه.

<AssignTo>variable_to_receive_cached_value</AssignTo>

الإعداد التلقائي:

لا ينطبق

الحضور:

مطلوب

النوع:

سلسلة

&lt;CacheKey&gt; عنصر

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

<CacheKey>
    <Prefix>string</Prefix>
    <KeyFragment ref="variable_name" />
    <KeyFragment>literal_string</KeyFragment>
</CacheKey>

الإعداد التلقائي:

لا ينطبق

الحضور:

مطلوب

النوع:

لا ينطبق

<CacheKey> تنشئ اسم كل جزء من البيانات المخزنة في الدالة ذاكرة التخزين المؤقت.

في وقت التشغيل، تتم إضافة قيم <KeyFragment> في البداية مع قيمة العنصر <Scope> أو القيمة <Prefix>. على سبيل المثال، النتائج التالية إلى مفتاح ذاكرة التخزين المؤقت UserToken__apiAccessToken__&lt;value_of_client_id&gt;:

<CacheKey>
    <Prefix>UserToken</Prefix>
    <KeyFragment>apiAccessToken</KeyFragment>
    <KeyFragment ref="request.queryparam.client_id" />
</CacheKey>

يمكنك استخدام العنصر <CacheKey> مع <Prefix> و<Scope> لمزيد من المعلومات، يمكنك الاطّلاع على العمل باستخدام مفاتيح ذاكرة التخزين المؤقت.

&lt;CacheLookupTimeoutInSeconds&gt; عنصر

تحدد عدد الثواني التي سيتم بعدها اعتبار البحث غير الناجح في ذاكرة التخزين المؤقت غير موجودة في ذاكرة التخزين المؤقت. وفي حال حدوث ذلك، سيتم استئناف العملية على طول مسار ذاكرة التخزين المؤقت المفقودة.

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

الإعداد التلقائي:

30

الحضور:

اختياري

النوع:

عدد صحيح

&lt;CacheResource&gt; عنصر

تحدِّد هذه السياسة ذاكرة التخزين المؤقت التي يجب تخزين الرسائل فيها.

احذف هذا العنصر تمامًا إذا كانت هذه السياسة (وسياسة Populatecache المقابلة لها سياسات Badatecache) تستخدم ذاكرة التخزين المؤقت المشتركة المضمنة.

<CacheResource>cache_to_use</CacheResource>

الإعداد التلقائي:

لا ينطبق

الحضور:

اختياري

النوع:

سلسلة

لمزيد من المعلومات حول ضبط ذاكرات التخزين المؤقت، يُرجى الاطّلاع على إنشاء بيئة وتعديلها. ذاكرة التخزين المؤقت.

&lt;CacheKey&gt;/&lt;KeyFragment&gt; عنصر

لتحديد قيمة يجب تضمينها في مفتاح ذاكرة التخزين المؤقت، لإنشاء مساحة اسم للمطابقة الطلبات للردود المخزنة مؤقتًا.

<KeyFragment ref="variable_name"/>
<KeyFragment>literal_string</KeyFragment>

الإعداد التلقائي:

لا ينطبق

الحضور:

اختياري

النوع:

لا ينطبق

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

<KeyFragment>apiAccessToken</KeyFragment>
<KeyFragment ref="request.queryparam.client_id" />

يمكنك استخدام العنصر <KeyFragment> مع <Prefix> و<Scope> لمزيد من المعلومات، يمكنك الاطّلاع على العمل باستخدام مفاتيح ذاكرة التخزين المؤقت.

السمات

السمة النوع تلقائي مطلوب الوصف
المرجع سلسلة لا

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

&lt;CacheKey&gt;/&lt;Prefix&gt; عنصر

تحدِّد هذه السياسة قيمة لاستخدامها كبادئة مفتاح ذاكرة التخزين المؤقت.

<Prefix>prefix_string</Prefix>

الإعداد التلقائي:

لا ينطبق

الحضور:

اختياري

النوع:

سلسلة

استخدِم هذه القيمة بدلاً من <Scope> عندما تريد تحديد القيمة الخاصة بك. بدلاً من قيمة تعداد تعداد <Scope>. إذا تم تحديدها، يضيف <Prefix> قيمة مفتاح ذاكرة التخزين المؤقت للإدخالات المكتوبة في ذاكرة التخزين المؤقت. حاسمة تلغي قيمة العنصر <Prefix> العنصر <Scope>

يمكنك استخدام العنصر <Prefix> مع <CacheKey> و<Scope> لمزيد من المعلومات، يمكنك الاطّلاع على العمل باستخدام مفاتيح ذاكرة التخزين المؤقت.

&lt;Scope&gt; عنصر

يُستخدم التعداد لإنشاء بادئة لمفتاح ذاكرة التخزين المؤقت عندما تحتوي السمة <Prefix> لم يتم توفيره في العنصر <CacheKey>.

<Scope>scope_enumeration</Scope>

الإعداد التلقائي:

"عرض حصري"

الحضور:

اختياري

النوع:

سلسلة

يحدِّد الإعداد <Scope> مفتاح ذاكرة تخزين مؤقت تتم إضافته أولاً وفقًا لما يلي: قيمة <Scope>. على سبيل المثال، يتخذ مفتاح ذاكرة التخزين المؤقت النموذج التالي عند تم ضبط النطاق على Exclusive : orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

إذا كان عنصر <Prefix> موجودًا في <CacheKey>، سيتم يحل محل قيمة العنصر <Scope>. تشمل القيم الصالحة التعدادات. أدناه.

يمكنك استخدام العنصر <Scope> مع <CacheKey> و<Prefix> لمزيد من المعلومات، يمكنك الاطّلاع على العمل باستخدام مفاتيح ذاكرة التخزين المؤقت.

القِيم المقبولة

Global

تتم مشاركة مفتاح ذاكرة التخزين المؤقت عبر جميع الخوادم الوكيلة لواجهة برمجة التطبيقات التي تم نشرها في البيئة. مفتاح ذاكرة التخزين المؤقت هو مسبوقة بالصيغة orgName __ envName __.

إذا حددت إدخال <CacheKey> باستخدام السمة <KeyFragment> apiAccessToken ونطاق <Global>، يتم تخزين كل إدخال كـ orgName__envName__apiAccessToken، متبوعًا القيمة المتسلسلة لرمز الدخول. بالنسبة للخادم الوكيل لواجهة برمجة التطبيقات الذي تم نشره في بيئة تسمى 'test' في مؤسسة تسمى "apifactory"، يتم تخزين رموز الدخول ضمن مفتاح التخزين المؤقت التالي: apifactory__test__apiAccessToken.

Application

يتم استخدام اسم الخادم الوكيل لواجهة برمجة التطبيقات كبادئة.

تتم إضافة مفتاح ذاكرة التخزين المؤقت في النموذج orgName__envName__applicationName.

Proxy

يتم استخدام إعداد ProxyEndpoint كبادئة.

تتم إضافة مفتاح ذاكرة التخزين المؤقت في النموذج orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName .

Target

يتم استخدام ضبط TargetEndpoint كبادئة.

تمت إضافة مفتاح ذاكرة التخزين المؤقت في النموذج orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .

Exclusive

تلقائي: هذا هو الأكثر تحديدًا، وبالتالي يقلِّل الحد الأدنى من مخاطر مساحة الاسم والتصادمات داخل ذاكرة تخزين مؤقت معينة.

تكون البادئة واحدة من شكلين:

  • وإذا تم ربط السياسة بمسار ProxyEndpoint، تكون البادئة نموذج ApiProxyName_ProxyEndpointName.
  • إذا تم إرفاق السياسة على TargetEndpoint، تكون البادئة على الشكل. ApiProxyName_TargetName.

تمت إضافة مفتاح ذاكرة التخزين المؤقت في النموذج orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

على سبيل المثال، قد تبدو السلسلة الكاملة كما يلي:

apifactory__test__weatherapi__16__default__apiAccessToken
.

ملاحظات الاستخدام

استخدِم هذه السياسة للتخزين المؤقت للأغراض العامة. في وقت التشغيل، تسترد السياسة WebGLcache من ذاكرة التخزين المؤقت، مع تعيين القيمة للمتغير الذي تحدده باستخدام العنصر AssignTo (إذا لم يتم استرداد أي قيمة، لن يتم ضبط المتغيّر). تبحث عن القيمة استنادًا إلى ذاكرة التخزين المؤقت الذي تم إنشاؤه من خلال الإعداد الذي يجمع بين عناصر cacheKey وعناصر النطاق. أو بعبارةٍ أخرى، لاسترداد قيمة معينة مضافة إلى ذاكرة التخزين المؤقت بواسطة سياسة Populatecache، عناصر مرتبطة بمفاتيح ذاكرة التخزين المؤقت ومهيأة بنفس الطريقة التي تم بها ضبط .

التخزين المؤقت للأغراض العامة من خلال سياسة تعبئة ذاكرة التخزين المؤقت، تستخدم سياسة Checkcache، وسياسة Spamatecache ذاكرة تخزين مؤقت تتم إعدادها أو ذاكرة تخزين مؤقت مشتركة يتم تضمينها بشكل افتراضي. في معظم الحالات، ذاكرة التخزين المؤقت المشتركة الأساسية احتياجاتك. لاستخدام ذاكرة التخزين المؤقت الافتراضية، احذف العنصر <CacheResource>.

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

متغيّرات التدفق

يمكن استخدام متغيرات التدفق لضبط سلوك بيئة التشغيل الديناميكي للسياسات والمسارات، استنادًا إلى حول عناوين HTTP أو محتوى الرسالة أو السياق المتوفر في "تدفق". لمزيد من المعلومات حول متغيرات التدفق، راجع المتغيرات المرجع.

تتوفر متغيرات التدفق المحددة مسبقًا التالية بعد تخصيص سلوك ذاكرة التخزين المؤقت التي تحددها في سياسة Checkcache.

المتغيرات النوع الإذن الوصف
lookupcache.{policy-name}.cachename سلسلة قراءة فقط تعرض اسم ذاكرة التخزين المؤقت المستخدَم في السياسة.
lookupcache.{policy-name}.cachekey سلسلة قراءة فقط لعرض المفتاح المستخدَم.
lookupcache.{policy-name}.cachehit منطقي قراءة فقط صحيح إذا عثرت السياسة على قيمة لمفتاح ذاكرة التخزين المؤقت المحدَّد.
lookupcache.{policy-name}.assignto سلسلة قراءة فقط تعرض المتغيّر الذي تم تخصيص ذاكرة التخزين المؤقت له.

رموز الخطأ

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

بادئة رمز الخطأ

لا ينطبق

أخطاء في وقت التشغيل

لا تؤدي هذه السياسة إلى حدوث أي أخطاء في وقت التشغيل.

أخطاء النشر

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

اسم الخطأ السبب إصلاح
InvalidCacheResourceReference يحدث هذا الخطأ عند ضبط العنصر <CacheResource> على اسم غير متوفّر في البيئة التي يتم فيها نشر الخادم الوكيل لواجهة برمجة التطبيقات.
InvalidTimeout وفي حال ضبط العنصر <CacheLookupTimeoutInSeconds> على رقم سالب، سيتعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات.
CacheNotFound يحدث هذا الخطأ إذا لم يتم إنشاء ذاكرة التخزين المؤقت المحددة المذكورة في رسالة الخطأ على مكون محدد لمعالجة الرسائل.

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

لا ينطبق

مثال على الردّ على الخطأ

لا ينطبق