سياسة SpikeArrest

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

توفّر سياسة "الحظر المرتفع" الحماية من الارتفاعات المفاجئة في حركة المرور باستخدام العنصر <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>

This element has the following attributes that are common to all policies:

أمثلة

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

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

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</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>

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, more natural-sounding name.

The <DisplayName> element is common to all policies.

The <DisplayName> element uses the following syntax:

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

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

The <DisplayName> element has no attributes or child elements.

<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 name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

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

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

<UseEffectiveCount>

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

<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. عند حذف العنصر من سياسة Spike Arrest.

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

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

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

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

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

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

عند تنفيذ سياسة Spike Arrest، تتم تعبئة متغيّر التدفق التالي:

لمزيد من المعلومات، يُرجى الاطّلاع على مرجع متغيّرات التدفق.

مرجع الخطأ

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

Shown below is an example error response:

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

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

<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" باستخدام واجهة برمجة التطبيقات الخاصة بتعديل خصائص المؤسسة

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

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). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

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

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