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

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

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

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

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

نماذج

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

'http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778' -H "bypass-cache:true"

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <!-- Explicitly refresh the cached response -->
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

مرجع العنصر

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" />
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSeconds ref="flow.variable.here">300</TimeoutInSeconds>
    </ExpirySettings>
    <CacheResource>cache_to_use</CacheResource>
    <CacheLookupTimeoutInSeconds/>
    <ExcludeErrorResponse/>
    <SkipCacheLookup/>
    <SkipCachePopulation/>
    <UseAcceptHeader/>
    <UseResponseCacheHeaders/>
</ResponseCache>

<ResponseCache> السمات

<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">

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

<DisplayName> عنصر

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

<DisplayName>Policy Display Name</DisplayName>

<CacheKey> عنصر

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

الحد الأقصى لحجم مفاتيح ذاكرة التخزين المؤقت هو 2 كيلوبايت.

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

تنشئ الدالة <CacheKey> اسم كل جزء من البيانات المخزّنة في ذاكرة التخزين المؤقت. وغالبًا ما يتم ضبط المفتاح باستخدام قيمة من عناوين الكيانات أو مَعلمات طلب البحث. في هذه الحالات، قد تجعل سمة ref للعنصر متغيرًا يحتوي على قيمة المفتاح.

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

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

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

<CacheLookupTimeoutInSeconds> عنصر

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

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

<CacheResource> عنصر

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

<CacheResource>cache_to_use</CacheResource>

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

<CacheKey>/<KeyFragment> عنصر

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

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

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

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

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

السمات

<CacheKey>/<Prefix> عنصر

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

<Prefix>prefix_string</Prefix>

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

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

<ExcludeErrorResponse> عنصر

في الوقت الحالي، يتم بشكل تلقائي تخزين هذه السياسة مؤقتًا مع استجابات HTTP مع أي خيار ممكن رمز الحالة. وهذا يعني أنه يتم تخزين استجابات النجاح والخطأ مؤقتًا. على سبيل المثال، الردود التي تحتوي على يتم تخزين رمزَي الحالة 2xx و 3xx مؤقتًا بشكل تلقائي.

اضبط هذا العنصر على true إذا كنت لا تريد التخزين المؤقت المستهدَف والاستجابات برموز حالة خطأ HTTP؛ سيتم فقط الرد برموز الحالة من 200 إلى 205 مؤقتًا إذا كان هذا العنصر true. هذه هي رموز حالة HTTP الوحيدة التي تحسبها Edge كـ "نجاح" ، ولا يمكنك تغيير هذا الارتباط.

لإجراء مناقشة حول أنماط ذاكرة التخزين المؤقت للردود التي يكون فيها هذا العنصر مفيدًا، يمكنك الاطّلاع على هذه المشاركة في "المنتدى".

ملاحظة: في إصدار مستقبلي (يتم تحديده)، يكون الإعداد التلقائي لهذا إلى "صواب". الاطّلاع على Apigee ملاحظات الإصدار للاطّلاع على التفاصيل.

<ExcludeErrorResponse>true</ExcludeErrorResponse>

<ExpirySettings> عنصر

تحدِّد هذه السياسة وقت انتهاء صلاحية أحد إدخالات ذاكرة التخزين المؤقت. عند توفّر الخدمة، <TimeoutInSeconds> تلغي كلاً من <TimeOfDay> و<ExpiryDate>.

<ExpirySettings>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
</ExpirySettings>

<ExpirySettings>/<ExpiryDate> عنصر

تحدِّد هذه السياسة التاريخ الذي يجب أن تنتهي فيه صلاحية أحد إدخالات ذاكرة التخزين المؤقت. استخدِم النموذج mm-dd-yyyy. عند توفّر العنصر، شقيق هذا العنصر، <TimeoutInSeconds>، يلغي <ExpiryDate>

<ExpirySettings>
    <ExpiryDate ref="{date_variable}">expiration_date</ExpiryDate>
</ExpirySettings>

السمات

<ExpiryDate ref="" />

<ExpirySettings>/<TimeOfDay> عنصر

الوقت من اليوم الذي ينبغي أن تنتهي فيه صلاحية أحد إدخالات ذاكرة التخزين المؤقت. استخدِم النموذج hh:mm:ss . عند توفّر العنصر، شقيق هذا العنصر، <TimeoutInSeconds>، يلغي <TimeOfDay>

أدخِل الوقت بالتنسيق HH:mm:ss، حيث تمثل HH الساعة بتنسيق 24 ساعة. بالنسبة على سبيل المثال، 14:30:00 لمدة 2:30 بعد الظهر.

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

<ExpirySettings>
    <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

السمات

<ExpirySettings>/<TimeoutInSec> عنصر

عدد الثواني التي ستنتهي بعدها صلاحية أحد إدخالات ذاكرة التخزين المؤقت.

<ExpirySettings>/<TimeoutInSeconds> عنصر

عدد الثواني التي ستنتهي بعدها صلاحية أحد إدخالات ذاكرة التخزين المؤقت. عند وجود هذا العنصر، تلغي عنصرَيها الشقيقَين، <TimeOfDay> و<ExpiryDate>.

<ExpirySettings>
    <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
</ExpirySettings>

ملاحظة: أدخِل قيمة مهلة تلقائية لاستخدامها إذا لم تتلقَّ المرجع قيمة من duration_variable

السمات

<Scope> عنصر

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

<Scope>scope_enumeration</Scope>

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

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

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

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

apifactory__test__weatherapi__16__default__apiAccessToken

<SkipCacheLookup> عنصر

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

<SkipCacheLookup>variable_condition_expression</SkipCacheLookup>

من المثال التالي، إذا تم تعيين متغير الاستبعاد المؤقت الخاص بذاكرة التخزين المؤقت على "صحيح" في رأس وارد، يتم تخطي البحث في ذاكرة التخزين المؤقت وتتم إعادة تحميل ذاكرة التخزين المؤقت.

<SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>

<SkipCachePopulation> عنصر

يحدد تعبيرًا، إذا تم تقييمه على "true" في وقت التشغيل، فإنه يحدد أن الكتابة إلى يجب تخطي ذاكرة التخزين المؤقت. راجع أيضًا هذه الصفحة فيديو حول استخدام EscapeCachePurchases.

<SkipCachePopulation>variable_condition_expression</SkipCachePopulation>

على سبيل المثال، ما يلي سيتخطى كتابة ذاكرة التخزين المؤقت إذا كان رمز حالة الاستجابة 400 أو أعلى:

<SkipCachePopulation>response.status.code >= 400</SkipCachePopulation>

<UseAcceptHeader> عنصر

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

تستخدم شبكة Edge Accept وAccept-Encoding وAccept-Language. وAccept-Charset تطلب عناوين عند حساب مفتاح ذاكرة التخزين المؤقت. هذا الأسلوب يمنع العميل من الحصول على نوع وسائط لم يطلبه.

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

يمكنك الاطّلاع على ضبط مفتاح ذاكرة تخزين مؤقت لمعرفة المزيد.

<UseAcceptHeader>false</UseAcceptHeader>

<UseResponseCacheHeaders> عنصر

يتم ضبط القيمة على true لمراعاة عناوين استجابة HTTP عند ضبط "الوقت على مباشر" (TTL) للاستجابة في ذاكرة التخزين المؤقت. عندما يكون هذا صحيحًا، تأخذ شبكة Edge في الاعتبار قيم بعد عناوين الاستجابة التالية، ومقارنة القيم بتلك التي تم تعيينها بواسطة <ExpirySettings> عند تحديد وقت البث المباشر:

• Cache-Control s-maxage
• Cache-Control max-age
• Expires

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

<UseResponseCacheHeaders>false</UseResponseCacheHeaders>

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

الحد الأقصى للحجم لكل عنصر مخزَّن مؤقتًا هو 256 كيلوبايت. (للحصول على معلومات تفصيلية حول كيفية استخدام Edge ذاكرة التخزين المؤقت، راجع ذاكرة التخزين المؤقت الداخلية).

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

لمزيد من المعلومات حول كيفية تعامل Edge مع عناوين الاستجابة من خلال سياسة Responsecache، يمكنك الاطّلاع على دعم عناوين استجابة HTTP.

ضبط انتهاء صلاحية إدخال ذاكرة التخزين المؤقت

وكما هو الحال مع ملء سياسة ذاكرة التخزين المؤقت، يمكنك ضبط تاريخ انتهاء صلاحية إدخال ذاكرة التخزين المؤقت للاستجابة (وقت نشره) باستخدام العنصر <ExpirySettings> في سياسة Responsecache، يمكنك أيضًا استخدام Edge مراعاة عناوين الاستجابة عندما تكون موجودة.

لاستخدام عناوين الاستجابة، يمكنك ضبط قيمة العنصر <UseResponseCacheHeaders> على صواب. يؤدي هذا الإعداد إلى جعل Edge يفكر في عناوين الاستجابة ويقارنها بمجموعة القيم في <ExpirySettings>، ثم استخدِم أدنى قيمة بينهما. فعندما بالنظر إلى عناوين الاستجابة، تختار Edge القيمة المتاحة كما هو موضح في التالي:

على سبيل المثال، تخيل أنه تم تخزين استجابة مؤقتًا بالقيم التالية:

• بلا قيمة Cache-Control s-maxage
• قيمة Cache-Control max-age بقيمة 300
• تاريخ Expires خلال ثلاثة أيام
• قيمة TimeoutInSeconds للسمة <ExpirySettings> بقيمة 600.

في هذه الحالة، سيتم استخدام قيمة max-age Cache-Control للسمة TTL لأنها أقل من قيمة <ExpirySettings> ولأن هناك لا قيمة Cache-Control s-maxage (لها الأولوية على max-age).

تهيئة مفتاح ذاكرة التخزين المؤقت

وكما هو الحال مع سياسات ذاكرة التخزين المؤقت ذات الأغراض العامة، مثل سياسة تعبئة ذاكرة التخزين المؤقت، باستخدام تستخدم Responsecache العنصرَين <CacheKey> و<Scope> من أجل تهيئة إنشاء مفتاح ذاكرة التخزين المؤقت لإدخالات ذاكرة التخزين المؤقت. من خلال ResponseCache، يمكنك أيضًا إنشاء مفاتيح ذاكرة التخزين المؤقت أكثر فائدة من خلال إلحاق عناوين اقبل بقيم المفاتيح.

للحصول على معلومات عامة عن ضبط مفاتيح ذاكرة التخزين المؤقت، يُرجى الاطّلاع على العمل باستخدام مفاتيح ذاكرة التخزين المؤقت. بالنسبة معلومات عن استخدام عناوين "قبول"، راجِع <UseAcceptHeader>.

معلومات عن تشفير ذاكرة التخزين المؤقت

Edge for Public Cloud: يتم تشفير ذاكرة التخزين المؤقت فقط في PCI: وتفعيل ميزة HIPAA المؤسسات. يتم ضبط التشفير لتلك المؤسسات أثناء عملية المؤسسة. توفير المتطلبات اللازمة.

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

تتم تعبئة متغيّرات التدفق المحدَّدة مسبقًا التالية عند تنفيذ سياسة Responsecache. لمزيد من المعلومات حول متغيّرات التدفق، اطّلِع على مرجع المتغيرات.

رموز الخطأ

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

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

لا ينطبق

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

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

أخطاء النشر

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

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

لا ينطبق

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

لا ينطبق

المخطط

يتم تحديد كل نوع سياسة من خلال مخطّط XML (.xsd). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.