سياسة إعادة ضبط الحصة

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

الأدوات المستخدمة

يُستخدَم لتعديل عدد الطلبات المتبقية المسموح بها بشكل ديناميكي بموجب سياسة الحصة المستهدَفة. تُستخدَم هذه السياسة عادةً لتقليل عدد الحصص الحالية في سياسة الحصص المستهدَفة، بدلاً من انتظار إعادة ضبط عدد الحصص.

على سبيل المثال، تفرض سياسة الحصة المستهدَفة على المطوّر حدًا أقصى يبلغ 1, 000 طلب في الأسبوع. وبحلول اليوم الثاني من الأسبوع، يكون المطوّر قد بلغ هذا الحدّ الأقصى. استخدِم سياسة إعادة ضبط الحصة لخصم 500 من عدّاد الحصة بهدف السماح بإجراء 500 طلب إضافي خلال ما تبقّى من الأسبوع. في نهاية الأسبوع، تتم إعادة ضبط سياسة الحصة، ويعود المطوّر إلى 1,000 طلب للأسبوع.

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

نماذج

توضّح عيّنات التعليمات البرمجية الخاصة بالسياسات التالية كيفية إعادة ضبط عدّادات الحصة:

إعادة ضبط العداد التلقائي

<ResetQuota name="resetQuota">
   <Quota name="MyQuotaPolicy">
      <Identifier name="_default">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

تحدّد سياسة "إعادة ضبط الحصة" سياسة الحصة المستهدَفة باستخدام السمة name للعلامة <Quota>. في المثال أعلاه، السياسة MyQuotaPolicy هي السياسة المستهدَفة.

تتطلّب جميع سياسات "إعادة ضبط الحصة" استخدام العلامة <Identifier> لتحديد العداد في سياسة "الحصة" المطلوب تعديله. تتضمّن سياسة الحصة تلقائيًا عدّادًا واحدًا، ما لم تتضمّن سياسة الحصة أيضًا العلامة <Identifier>. في هذا المثال، لا تستخدم سياسة الحصة المستهدَفة العلامة <Identifier>، لذا عليك تحديد السمة name بالقيمة _default.

يحدّد العنصر <Allow> القيمة المستخدَمة لخفض عدد الحصة الحالية في السياسة المستهدَفة. في هذا المثال، يتم خفض عدد الحصص بمقدار 100، وذلك للسماح بإجراء 100 طلب إضافي لسياسة الحصة المستهدَفة. عند إعادة ضبط سياسة الحصة المستهدَفة، يتم تجاهل هذا التغيير.

في ما يلي تعريف سياسة الحصة المستهدَفة:

<Quota name="MyQuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

استخدام مرجع

<ResetQuota name="resetQuota">
   <Quota ref="request.header.quotapolicy">
      <Identifier name="_default">
         <Allow ref="request.header.allowquota" />
      </Identifier>
   </Quota>
</ResetQuota>

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

تحديد المعرّف

<ResetQuota name="resetQuota">
   <Quota name="QuotaPolicy">
      <Identifier ref="request.header.clientId">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

إذا كانت سياسة الحصة المستهدَفة تحدّد العلامة <Identifier>، يمكنك تحديد القيمة نفسها للعلامة <Identifier> في سياسة إعادة ضبط الحصة لتعديل عدد حصة معيّنة. لاحظ كيف تتطابق العلامة <Identifier> في سياسة الحصة المستهدَفة أدناه مع القيمة المحدّدة في سياسة إعادة ضبط الحصة:

<Quota name="QuotaPolicy">
  <Identifier ref="request.header.clientId"/>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

مرجع العنصر

يصف مرجع العنصر عناصر وسمات سياسة إعادة ضبط الحصة.

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
   <DisplayName>Reset Quota 1</DisplayName>
   <Quota name="quotaName" ref="request.header.quotapolicy">
      <Identifier name="identifierName" ref="request.header.identifier">
         <Class ref="request.header.classIdentifier" />
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

سمات <ResetQuota>

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">

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

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

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

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

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

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

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

خطأ اختياري
enabled

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

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

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

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

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

&lt;DisplayName&gt; عنصر

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

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

لا ينطبق

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

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

العنصر <Quota>

تحدّد هذه السمة سياسة الحصة المستهدَفة التي يجب تعديل العداد الخاص بها.

<Quota name="quotaName"  ref="request.header.quotapolicy">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
القيمة التلقائية: لا ينطبق
الحضور: مطلوب
النوع: لا ينطبق

السمات

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

تحدّد هذه السمة اسم سياسة الحصة المستهدَفة.

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

العنصر <Quota>/<Identifier>

متغيّر يُستخدَم لتحديد العداد بشكلٍ فريد إذا كانت سياسة الحصة المستهدَفة تحدّد العلامة <Identifier>.

<Quota name="quotaName">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
القيمة التلقائية: لا ينطبق
الحضور: مطلوب
النوع: سلسلة

السمات

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

تحدّد هذه السمة اسم معرّف العدد في سياسة الحصة المستهدَفة. بالنسبة إلى سياسة الحصة التي لا تستخدم العلامة <Identifier>، حدِّد _default.

لا ينطبق اختياري
ref

متغيّر في سير العمل يحتوي على اسم معرّف العدد في سياسة الحصة المستهدَفة. إذا تم تحديد كل من ref وname، ستكون الأولوية لـ ref. إذا لم يتم تحديد قيمة ref في وقت التشغيل، سيتم استخدام name.

لا ينطبق اختياري

العنصر <Quota>/<Identifier>/<Allow>

تحدّد هذه السمة مقدار خفض عدّاد الحصة. يجب تحديد <Allow>، وإلا لن تعدّل السياسة الحصة.

<Identifier name="identifierName" ref="request.header.identifier">
   <Allow ref="request.header.allowquota">100</Allow>
</Identifier>
القيمة التلقائية: لا ينطبق
الحضور: مطلوب
النوع: عدد صحيح

السمات

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

متغيّر سير عمل يحتوي على التغيير في عدد الحصص في سياسة الحصص المستهدَفة

لا ينطبق اختياري

العنصر <Quota>/<Identifier>/<Class>

تحدّد هذه السمة الفئة التي يتم تعديل عدّاد الحصة فيها. لمزيد من المعلومات حول استخدام الفئة مع سياسة الحصة، يُرجى الاطّلاع على سياسة الحصة.

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
القيمة التلقائية: لا ينطبق
الحضور: اختياري
النوع: لا ينطبق

السمات

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

مرجع إلى متغيّر التدفق الذي يحتوي على فئة الحصة المراد تعديلها.

لا ينطبق اختياري

مرجع الخطأ

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

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

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

رمز الخطأ رموز حالة HTTP السبب إصلاح
policies.resetquota.InvalidRLPolicy 500 لم يتم تحديد سياسة الحصة المحدّدة في العنصر <Quota> ضمن سياسة إعادة ضبط الحصة في الخادم الوكيل لواجهة برمجة التطبيقات، وبالتالي لا تتوفّر أثناء العملية. العنصر <Quota> إلزامي ويحدّد سياسة الحصة المستهدفة التي يجب تعديل عدّادها من خلال سياسة إعادة ضبط الحصة.
policies.resetquota.FailedToResolveAllowCountRef لا ينطبق لا يمكن تحويل المرجع إلى المتغيّر الذي يتضمّن عدد المسموح به في العنصر <Allow> في السياسة إلى قيمة. هذا العنصر إلزامي ويحدد المبلغ المطلوب لخفض عدّاد الحصة.
policies.resetquota.FailedToResolveRLPolicy 500 لا يمكن حلّ المتغيّر الذي تشير إليه السمة ref في العنصر <Quota>.

أخطاء النشر

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

اسم الخطأ السبب إصلاح
InvalidCount إذا لم تكن قيمة العدد المحدّدة في العنصر <Allow> في "سياسة إعادة ضبط الحصص" عددًا صحيحًا، سيتعذّر نشر الخادم الوكيل لواجهة برمجة التطبيقات.

المخططات

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

سياسة الحصص