سياسة صلاحية ذاكرة التخزين المؤقت

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

تحدِّد هذه السياسة طريقة إزالة القيم المخزّنة مؤقتًا من ذاكرة التخزين المؤقت.

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

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

مرجع العنصر

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

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

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

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

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

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

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

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

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

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

خطأ اختياري
enabled

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

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

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

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

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

&lt;DisplayName&gt; عنصر

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

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

لا ينطبق

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

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

&lt;CacheContext&gt;/&lt;APIProxyName&gt; عنصر

تُحدِّد هذه السياسة اسم التطبيق الذي أضاف إدخال ذاكرة التخزين المؤقت.

<APIProxyName>application_that_added_the_entry</APIProxyName>

السمات

السمة الوصف تلقائي التواجد في المنزل النوع
المرجع متغير باسم التطبيق. لا ينطبق اختياري سلسلة

&lt;CacheContext&gt; عنصر

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

<CacheContext>
  <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName>
  <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName>
  <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName>
</CacheContext>

يُستخدَم لإنشاء مفتاح ذاكرة التخزين المؤقت. قيم APIProxyName وProxyName وTargetName هي إلزامي في حال عدم استخدام بادئة cacheKey (أي بادئة مخصَّصة) لمحو إدخالات ذاكرة التخزين المؤقت تمت إضافتها بواسطة خادم وكيل آخر لواجهة برمجة التطبيقات.

&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;CacheResource&gt; عنصر

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

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

<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;CacheContext&gt;/&lt;ProxyName&gt; عنصر

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

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

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

لا ينطبق

الحضور:

اختياري

النوع:

سلسلة

السمات

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

&lt;PurgeChildEntries&gt; عنصر

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

يجب تحديد العنصر <KeyFragment>. إذا لم يكن الأمر كذلك، يمكن أن يؤدي الضبط على "صحيح" لـ <PurgeChildEntries> إلى إزالة جميع الإدخالات في ذاكرة التخزين المؤقت.

يمكن أن يكون إلغاء صلاحية جميع إدخالات ذاكرة التخزين المؤقت لقيمة جزء المفتاح نفسها طريقة مفيدة إزالة عدة إدخالات ذات صلة نهائيًا في آنٍ واحد

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

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

خطأ

الحضور:

اختياري

النوع:

منطقي

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

&lt;CacheContext&gt;/&lt;TargetName&gt; عنصر

تُحدِّد اسم نقطة النهاية المستهدَفة التي تم تخزين البيانات مؤقتًا لها.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

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

لا ينطبق

الحضور:

اختياري

النوع:

سلسلة

السمات

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

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

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

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

رموز الخطأ

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

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

لا ينطبق

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

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

أخطاء النشر

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

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

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

لا ينطبق

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

لا ينطبق