سياسة SpikeArrest

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

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

عنصر <SpikeArrest>

تحدّد سياسة إيقاف الارتفاعات المفاجئة.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <DisplayName>display_name</DisplayName>
  <Properties/>
  <Identifier ref="flow_variable"/>
  <MessageWeight ref="flow_variable"/>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest-1">
  <DisplayName>Spike Arrest-1</DisplayName>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

يتضمن هذا العنصر السمات التالية الشائعة لجميع السياسات:

أمثلة

توضّح الأمثلة التالية بعض الطرق التي يمكنك من خلالها استخدام سياسة "إيقاف الارتفاعات المفاجئة في عدد الزيارات":

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate ref="request.header.runtime_rate" />
</SpikeArrest>

curl http://myorg-myenv.apigee.net/price -H 'runtime_rate:30ps'

مرجع العنصر الفرعي

يصف هذا القسم العناصر الفرعية لعنصر <SpikeArrest>.

<DisplayName>

استخدِم السمة name بالإضافة إلى سمة name لتصنيف السياسة في محرِّر واجهة المستخدم الوكيل لمدير باستخدام اسم مختلف يبدو أكثر طبيعية.

العنصر <DisplayName> شائع في جميع السياسات.

يستخدم العنصر <DisplayName> البنية التالية:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

لا يحتوي العنصر <DisplayName> على سمات أو عناصر فرعية.

<Identifier>

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

استخدِم هذا العنصر مع عنصر <MessageWeight> للتحكّم بشكل أدق في الحدّ من عدد الطلبات.

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

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Identifier ref="flow_variable"/>
</SpikeArrest>
        

<SpikeArrest name="Spike-Arrest-1">
  <Identifier ref="developer.id"/>
  <Rate>42pm</Rate/>
</SpikeArrest>

يوضّح الجدول التالي سمات <Identifier>:

تتم أيضًا مناقشة هذا العنصر في المشاركة التالية في منتدى Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

تُحدِّد هذه السمة الوزن المحدَّد لكل رسالة. يُعدّل وزن الرسالة تأثير طلب واحد في احتساب معدّل إيقاف الارتفاعات المفاجئة. يمكن أن يكون وزن الرسالة أي متغيّر تدفق، مثل عنوان HTTP أو مَعلمة طلب بحث أو مَعلمة نموذج أو محتوى نص الرسالة. يمكنك أيضًا استخدام متغيّرات مخصّصة باستخدام سياسة JavaScript أو سياسة AssignMessage.

استخدِم هذا الخيار مع <Identifier> لزيادة الحدّ من الطلبات من قِبل عملاء أو تطبيقات معيّنة.

على سبيل المثال، إذا كان الحدّ الأقصى لمعدل زيادة عدد الطلبات <Rate> هو 10pm، وأرسل تطبيق طلبات بقيمة 2، يُسمح بخمس رسائل فقط في الدقيقة من العميل لأنّ كل طلب يُحتسب على أنّه طلبان.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

يوضّح الجدول التالي سمات <MessageWeight>:

<Rate>

يحدِّد معدّل الحدّ من الارتفاعات المفاجئة في عدد الزيارات (أو الذروات) من خلال ضبط عدد الطلبات المسموح بها في فواصل دقيقة أو ثانية. يمكنك أيضًا استخدام هذا العنصر مع <Identifier> و<MessageWeight> لتقليل عدد الزيارات بسلاسة أثناء التشغيل من خلال قبول القيم من العميل.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

يوضّح الجدول التالي سمات <Rate>:

<Rate ref="request.header.custom_rate">1pm</Rate>

<UseEffectiveCount>

توزّع أعداد عمليات إيقاف الارتفاعات المفاجئة على معالجات الرسائل (MP) عند استخدام مجموعات التوسّع التلقائي.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name='Spike-Arrest-1'>
  <Rate>40ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

العنصر <UseEffectiveCount> اختياري. القيمة التلقائية هي false عند حذف العنصر من سياسة "إيقاف الارتفاعات المفاجئة في عدد الزيارات".

يوضّح الجدول التالي سمات العنصر <UseEffectiveCount>:

يعتمد تأثير <UseEffectiveCount> على قيمته:

• true: الحدّ الأقصى لمعدّل الذروة لوحدة معالجة المهام هو <Rate> مقسومًا على العدد الحالي لوحدات معالجة المهام في المجموعة نفسها. الحدّ الأقصى المجمّع هو القيمة لـ <Rate>. عند إضافة (أو إزالة) الطلبات المتعدّدة بشكل ديناميكي، ستزيد (أو تنخفض) حدود معدّل الذروة الفردي ، ولكن سيظل الحدّ الإجمالي كما هو.
• ‫false (هذه هي القيمة التلقائية في حال حذفها): الحد الأقصى لمعدل الذروة لكل ملف شخصي هو ببساطة قيمة <Rate>. الحدّ الأقصى المجمّع هو مجموع الأسعار لجميع الوحدات الإعلانية. عند إضافة (أو إزالة) رسائل MP، ستظلّ حدود معدّل الذروة الفردية كما هي، ولكن سيزداد الحدّ الإجمالي (أو ينخفض).

يوضّح الجدول التالي تأثير <UseEffectiveCount> في الحدّ الأقصى لمعدّل التحميل الفعال لكل ملف MP3:

في هذا المثال، يُرجى ملاحظة أنّه عند خفض عدد الوحدات من 4 إلى 2، ويكون <UseEffectiveCount> هو false، يظلّ معدّل التكلفة الفعّال لكل وحدة كما هو (عند 10). ولكن عندما يكون <UseEffectiveCount> يساوي true، ينتقل المعدّل الفعّال لكلّ نائب من 10 إلى 20 عند انخفاض عدد النواب من 4 إلى 2.

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

عند تنفيذ سياسة "إيقاف الارتفاعات المفاجئة في عدد الزيارات"، يتم تعبئة متغيّر المسار التالي:

لمزيد من المعلومات، يُرجى الاطّلاع على مرجع متغيّرات مسار الإحالة الناجحة.

مرجع الخطأ

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

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

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

أخطاء النشر

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

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

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

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

فيما يلي مثال على الرد على الخطأ:

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

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

في ما يلي مثال على قاعدة أخطاء للتعامل مع خطأ SpikeArrestViolation:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

رمز حالة HTTP الحالي لتجاوز الحدّ الأقصى للمعدل الذي تحدّده سياسة الحصة أو سياسة إيقاف الطلبات المفاجئة هو 429 (عدد كبير جدًا من الطلبات). لتغيير رمز حالة HTTP إلى 500 (خطأ في الخادم الداخلي)، اضبط قيمة العنصر features.isHTTPStatusTooManyRequestEnabled على false باستخدام ‫ واجهة برمجة التطبيقات Update organization properties.

على سبيل المثال:

curl -u email:password -X POST -H "Content-type:application/xml" http://api.enterprise.apigee.com/v1/organizations/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isHTTPStatusTooManyRequestEnabled">true</Property>
        . . .
    </Properties>
</Organization>"

المخططات

يتم تحديد كل نوع سياسة من خلال مخطّط XML (.xsd). يُرجى العِلم أنّ مخطّطات السياسات متاحة على GitHub.

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

• سياسة الحصة: سياسة الحصة، لتقييد عدد الزيارات على عملاء فرديين
• تقييد معدّل الزيارات للحصول على نظرة عامة على تقييد
• مقارنة سياستَي Quota وSpikeArrest
• نماذج صالحة للخوادم الوكيلة لواجهات برمجة التطبيقات