سیاست SpikeArrest

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

خط مشی Spike Arrest با عنصر <Rate> در برابر افزایش ترافیک محافظت می کند. این عنصر تعداد درخواست‌هایی را که توسط یک پروکسی API پردازش می‌شوند و به یک باطن ارسال می‌شوند کاهش می‌دهد و در برابر تاخیرهای عملکرد و خرابی محافظت می‌کند.

عنصر <SpikeArrest>

خط مشی Spike Arrest را تعریف می کند.

<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:

نمونه ها

مثال‌های زیر برخی از روش‌های استفاده از خط‌مشی Spike Arrest را نشان می‌دهند:

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

علاوه بر ویژگی name ، برای برچسب گذاری خط مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و طبیعی تر، از آن استفاده کنید.

عنصر <DisplayName> در همه خط مشی ها مشترک است.

عنصر <DisplayName> از نحو زیر استفاده می کند:

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

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

عنصر <DisplayName> هیچ ویژگی یا عنصر فرزند ندارد.

<Identifier>

به شما امکان می‌دهد نحوه گروه‌بندی درخواست‌ها را انتخاب کنید تا خط‌مشی Spike Arrest بر اساس مشتری اعمال شود. برای مثال، می‌توانید درخواست‌ها را بر اساس شناسه توسعه‌دهنده گروه‌بندی کنید، در این صورت درخواست‌های هر توسعه‌دهنده به‌حساب نرخ دستگیری Spike خودش حساب می‌شود و نه همه درخواست‌ها به پروکسی.

در ارتباط با عنصر <MessageWeight> برای کنترل دقیق تر بر کاهش درخواست استفاده کنید.

اگر عنصر <Identifier> را خالی بگذارید، یک محدودیت نرخ برای همه درخواست‌های آن پراکسی API اعمال می‌شود.

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

وزن تعریف شده برای هر پیام را مشخص می کند. وزن پیام تأثیر یک درخواست واحد را در محاسبه نرخ دستگیری Spike تغییر می‌دهد. وزن پیام می تواند هر متغیر جریانی باشد، مانند هدر HTTP، پارامتر پرس و جو، پارامتر فرم یا محتوای متن پیام. همچنین می توانید از متغیرهای سفارشی با استفاده از خط مشی جاوا اسکریپت یا خط مشی AssignMessage استفاده کنید.

در ارتباط با <Identifier> برای کاهش بیشتر درخواست‌های مشتریان یا برنامه‌های خاص استفاده کنید.

به عنوان مثال، اگر Spike Arrest <Rate> 10pm باشد، و یک برنامه درخواست هایی با وزن 2 ارسال می کند، در این صورت فقط پنج پیام در دقیقه از طرف مشتری مجاز است زیرا هر درخواست 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>

هنگام استفاده از گروه‌های مقیاس‌بندی خودکار، تعداد Spike Arrest شما را در بین پردازشگرهای پیام (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> اختیاری است. وقتی عنصر از خط مشی Spike Arrest حذف می شود، مقدار پیش فرض false است.

جدول زیر ویژگی های عنصر <UseEffectiveCount> را شرح می دهد:

اثر <UseEffectiveCount> به مقدار آن بستگی دارد:

• true : حد افزایش نرخ یک MP برابر <Rate> تقسیم بر تعداد نمایندگان فعلی در همان pod است. حد مجموع مقدار <Rate> است. وقتی MP به صورت پویا اضافه می‌شوند (یا حذف می‌شوند)، محدودیت‌های نرخ افزایش فردی آنها افزایش (یا کاهش) می‌یابد، اما حد مجموع ثابت می‌ماند.
• false (اگر حذف شود این مقدار پیش‌فرض است): محدودیت نرخ افزایش هر MP به سادگی مقدار <Rate> آن است. حد مجموع، مجموع نرخ تمام نمایندگان مجلس است. هنگامی که نمایندگان مجلس اضافه می شوند (یا حذف می شوند)، محدودیت های نرخ افزایش فردی آنها ثابت می ماند، اما حد کل افزایش (یا کاهش می یابد).

جدول زیر تأثیر <UseEffectiveCount> را بر محدودیت نرخ مؤثر هر MP نشان می دهد:

در این مثال، توجه داشته باشید که وقتی تعداد MP از 4 به 2 کاهش می یابد، و <UseEffectiveCount> false است، نرخ موثر هر MP ثابت می ماند (در 10). اما زمانی که <UseEffectiveCount> true باشد، نرخ موثر در هر MP از 10 به 20 می رود زمانی که تعداد MP از 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 برای فراتر از حد نرخ تعیین شده توسط خط مشی Quota یا Spike Arrest 429 است (درخواست های خیلی زیاد). برای تغییر کد وضعیت HTTP به 500 (خطای سرور داخلی)، ویژگی features.isHTTPStatusTooManyRequestEnabled را با استفاده از به روز رسانی API خصوصیات سازمانی روی 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 ) تعریف می شود. برای مرجع، طرح‌های خط‌مشی در GitHub در دسترس هستند.

موضوعات مرتبط

• خط مشی سهمیه : خط مشی سهمیه، برای محدود کردن ترافیک روی مشتریان فردی
• محدود کردن نرخ برای یک نمای کلی محدود کننده نرخ
• مقایسه سهمیه و سیاست های SpikeArrest
• نمونه های کاری از پروکسی های API