خط‌مشی سهمیه

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

چه

از خط‌مشی «سهمیه» برای پیکربندی تعداد پیام‌های درخواست که یک پراکسی API در یک دوره زمانی، مانند یک دقیقه، یک ساعت، یک روز، یک هفته یا یک ماه، مجاز می‌کند، استفاده کنید. می‌توانید سهمیه را برای همه برنامه‌هایی که به پراکسی API دسترسی دارند یکسان تنظیم کنید، یا می‌توانید سهمیه را براساس موارد زیر تنظیم کنید:

• محصولی که حاوی پراکسی API است
• برنامه‌ای که میانای برنامه‌سازی کاربردی را درخواست می‌کند
• توسعه‌دهنده نرم‌افزار
• معیارهای بسیار دیگر

از «سهمیه» برای محافظت دربرابر افزایش ناگهانی ترافیک کلی استفاده نکنید. برای این کار، از خط‌مشی Spike Arrest استفاده کنید. خط‌مشی «مهار جهش» را ببینید.

ویدیوها

این ویدیوها مدیریت سهمیه را با خط‌مشی سهمیه معرفی می‌کنند:

نمونه‌ها

این نمونه‌های کد خط‌مشی نشان می‌دهند که چگونه دوره‌های سهمیه را با موارد زیر شروع و پایان دهید:

<Quota name="CheckQuota">
  <Interval ref="verifyapikey.verify-api-key.apiproduct.developer.quota.interval">1</Interval>
  <TimeUnit ref="verifyapikey.verify-api-key.apiproduct.developer.quota.timeunit">hour</TimeUnit>
  <Allow count="200" countRef="verifyapikey.verify-api-key.apiproduct.developer.quota.limit"/>
</Quota>

<Quota name="DeveloperQuota">
  <Identifier ref="verifyapikey.verify-api-key.client_id"/>
  <Interval ref="verifyapikey.verify-api-key.developer.timeInterval"/>
  <TimeUnit ref="verifyapikey.verify-api-key.developer.timeUnit"/>
  <Allow countRef="verifyapikey.verify-api-key.developer.limit"/>
</Quota>

<Quota name="QuotaPolicy" type="calendar">
  <StartTime>2017-02-18 10:30:00</StartTime>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<Quota name="QuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<AssignMessage async="false" continueOnError="false" enabled="true" name="ReturnQuotaVars">
    <AssignTo createNew="false" type="response"/>
    <Set>
        <Headers>
            <Header name="QuotaLimit">{ratelimit.QuotaPolicy.allowed.count}</Header>
            <Header name="QuotaUsed">{ratelimit.QuotaPolicy.used.count}</Header>
            <Header name="QuotaResetUTC">{ratelimit.QuotaPolicy.expiry.time}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

<Quota name="MyQuota">
  <Interval>1</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="10000"/>
</Quota>

<Quota name="QuotaPolicy" type="calendar">
  <Identifier ref="request.header.clientId"/>
  <StartTime>2017-02-18 10:00:00</StartTime>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<Identifier ref="request.queryparam.id"/>

<Identifier ref="verifyapikey.verify-api-key.client_id"></Identifier>

<Quota name="QuotaPolicy">
  <Interval>1</Interval>
  <TimeUnit>day</TimeUnit>
  <Allow>
    <Class ref="request.header.developer_segment">
      <Allow class="platinum" count="10000"/>
      <Allow class="silver" count="1000" />
    </Class>
  </Allow>
</Quota>

درباره خط‌مشی سهمیه

«سهمیه» عبارت است از تخصیص پیام‌های درخواست که یک پراکسی API می‌تواند در یک دوره زمانی، مثل دقیقه، ساعت، روز، هفته، یا ماه، مدیریت کند. این خط‌مشی شمارنده‌هایی را حفظ می‌کند که تعداد درخواست‌های دریافتی توسط پراکسی API را شمارش می‌کنند. این قابلیت به ارائه‌دهندگان API امکان می‌دهد محدودیت‌هایی را بر تعداد تماس‌های API که برنامه‌ها در یک بازه زمانی برقرار می‌کنند اعمال کنند. بااستفاده از خط‌مشی‌های سهمیه می‌توانید، برای مثال، برنامه‌ها را به ۱ درخواست در دقیقه، یا به ۱۰٬۰۰۰ درخواست در ماه محدود کنید.

برای مثال، اگر «سهمیه» به‌عنوان ۱۰٬۰۰۰ پیام در ماه تعریف شده باشد، محدود کردن نرخ پس‌از پیام دهم‌هزارم شروع می‌شود. مهم نیست که آیا ۱۰٬۰۰۰ پیام در روز اول یا روز آخر آن دوره شمارش شده است؛ تا زمانی که شمارنده «سهمیه» به‌طور خودکار در پایان بازه زمانی مشخص‌شده بازنشانی شود، یا تا زمانی که «سهمیه» به‌طور صریح بااستفاده از خط‌مشی «بازنشانی سهمیه» بازنشانی شود، هیچ درخواست اضافی مجاز نیست.

گونه‌ای از «سهمیه» به‌نام SpikeArrest از جهش‌های ترافیکی (یا انفجارها) که می‌تواند ناشی از افزایش ناگهانی استفاده، مشتریان دارای اشکال، یا حملات مخرب باشد جلوگیری می‌کند. برای اطلاعات بیشتر درباره SpikeArrest، به خط‌مشی Spike Arrest مراجعه کنید.

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

انواع خط‌مشی سهمیه

خط‌مشی «سهمیه» از چندین نوع خط‌مشی مختلف پشتیبانی می‌کند: پیش‌فرض، calendar، flexi، و rollingwindow. هر نوع مشخص می‌کند که شمارنده سهمیه چه زمانی شروع می‌شود و چه زمانی بازنشانی می‌شود، همان‌طور که در جدول زیر نشان داده شده است:

برای type="calendar"، باید مقدار <StartTime> را مشخص کنید.

جدول مقدار نوع rollingwindow را فهرست نمی‌کند. سهمیه‌های پنجره چرخشی با تنظیم اندازه «پنجره» سهمیه، مانند پنجره یک ساعته یا یک روزه، کار می‌کنند. وقتی درخواست جدیدی ارسال می‌شود، خط‌مشی تعیین می‌کند که آیا در «بازه» زمانی گذشته از سهمیه فراتر رفته‌اید یا نه.

برای مثال، بازه زمانی دو ساعته‌ای تعریف می‌کنید که اجازه می‌دهد ۱۰۰۰ درخواست ارسال شود. درخواست جدیدی در ساعت ۴:۴۵ بعدازظهر دریافت می‌شود.خط‌مشی تعداد سهمیه را برای بازه زمانی دو ساعت گذشته محاسبه می‌کند، یعنی تعداد درخواست‌ها از ساعت ۲:۴۵ بعدازظهر. اگر در آن بازه دو ساعته از حد سهمیه فراتر نرفته باشید، درخواست مجاز است.

یک دقیقه بعد، در ساعت ۴:۴۶ بعدازظهر، درخواست دیگری وارد می‌شود. اکنون خط‌مشی تعداد سهمیه را از ساعت ۲:۴۶ بعدازظهر محاسبه می‌کند تا مشخص شود که آیا از حد مجاز فراتر رفته‌اید یا نه.

برای نوع rollingwindow، شمارنده هرگز بازنشانی نمی‌شود، اما در هر درخواست دوباره محاسبه می‌شود.

آشنایی با شمارشگرهای سهمیه

به‌طور پیش‌فرض، خط‌مشی «سهمیه» یک شمارنده واحد را حفظ می‌کند، صرف‌نظر از اینکه چند بار در یک پراکسی API به آن ارجاع دهید. نام شمارنده سهمیه براساس ویژگی name خط‌مشی است.

برای مثال، خط‌مشی «سهمیه» با نام MyQuotaPolicy با محدودیت ۵ درخواست ایجاد می‌کنید و آن را در چندین جریان (جریان A،‏ B، و C) در پراکسی API قرار می‌دهید. اگرچه در چندین جریان استفاده می‌شود، اما شمارنده واحدی دارد که توسط همه نمونه‌های خط‌مشی به‌روز می‌شود:

• جریان A اجرا می‌شود -> MyQuotaPolicy اجرا می‌شود و شمارنده آن = ۱
• جریان B اجرا می‌شود -> MyQuotaPolicy اجرا می‌شود و شمارنده آن = ۲
• جریان A اجرا می‌شود -> MyQuotaPolicy اجرا می‌شود و شمارنده آن = ۳
• جریان C اجرا می‌شود -> MyQuotaPolicy اجرا می‌شود و شمارنده آن = ۴
• جریان A اجرا می‌شود -> MyQuotaPolicy اجرا می‌شود و شمارنده آن = ۵

درخواست بعدی برای هریک از این سه جریان رد می‌شود زیرا شمارنده سهمیه به حد مجاز خود رسیده است.

استفاده از خط‌مشی «سهمیه» یکسان در بیش‌از یک مکان در جریان پراکسی API، که می‌تواند به‌طور ناخواسته باعث شود «سهمیه» سریع‌تر از آنچه انتظار دارید تمام شود، یک ضدالگو است که در کتاب ضدالگوهای Apigee Edge شرح داده شده است.

یا می‌توانید چندین خط‌مشی «سهمیه» را در پراکسی API خود تعریف کنید و در هر جریان از خط‌مشی متفاوتی استفاده کنید. هر خط‌مشی «سهمیه» براساس ویژگی name خط‌مشی، شمارنده خودش را حفظ می‌کند.

یا از عناصر <Class> یا <Identifier> در خط‌مشی «سهمیه» برای تعریف چندین شمارنده یکتا در یک خط‌مشی استفاده کنید. بااستفاده از این عناصر، یک خط‌مشی می‌تواند براساس برنامه درخواست‌کننده، توسعه‌دهنده برنامه درخواست‌کننده، شناسه مشتری یا شناسه مشتری دیگر، و موارد دیگر، شمارنده‌های مختلفی را حفظ کند. برای اطلاعات بیشتر درباره استفاده از عناصر <Class> یا <Identifier>، مثال‌های بالا را ببینید.

نشانه‌گذاری زمان

همه زمان‌های «سهمیه» روی منطقه زمانی ساعت هماهنگ جهانی (UTC) تنظیم شده است.

نوشتار زمان سهمیه از نوشتار تاریخ استاندارد بین‌المللی که در استاندارد بین‌المللی ISO 8601 تعریف شده است پیروی می‌کند.

تاریخ‌ها به‌صورت سال، ماه، و روز در قالب زیر تعریف می‌شوند: YYYY-MM-DD. برای مثال، 2015-02-04 نشان‌دهنده ۴ فوریه ۲۰۱۵ است.

زمان روز به‌صورت ساعت، دقیقه، و ثانیه در قالب زیر تعریف می‌شود: hours:minutes:seconds. برای مثال، 23:59:59 نشان‌دهنده یک ثانیه قبل‌از نیمه‌شب است.

توجه داشته باشید که دو نماد، 00:00:00 و 24:00:00، برای تمایز بین دو نیمه‌شبی که می‌توانند با یک تاریخ مرتبط شوند دردسترس هستند. بنابراین 2015-02-04 24:00:00 همان تاریخ و ساعت 2015-02-05 00:00:00 است. دومی معمولاً نوشتار ترجیحی است.

دریافت تنظیمات سهمیه از پیکربندی محصول میانای برنامه‌سازی کاربردی

می‌توانید محدودیت‌های سهمیه را در پیکربندی‌های محصول API تنظیم کنید. این محدودیت‌ها به‌طور خودکار سهمیه را اعمال نمی‌کنند. درعوض، می‌توانید به تنظیمات سهمیه محصول در خط‌مشی سهمیه ارجاع دهید. در اینجا چند مزیت تعیین سهمیه برای محصول آورده شده است تا خط‌مشی‌های سهمیه به آن ارجاع دهند:

• خط‌مشی‌های سهمیه می‌توانند از تنظیم یکنواخت در سراسر پراکسی‌های میانای برنامه‌سازی کاربردی در محصول میانای برنامه‌سازی کاربردی استفاده کنند.
• می‌توانید در زمان اجرا تغییراتی در تنظیم سهمیه محصول API ایجاد کنید و خط‌مشی‌های سهمیه‌ای که به مقدار ارجاع می‌دهند به‌طور خودکار مقادیر سهمیه را به‌روزرسانی می‌کنند.

برای اطلاعات بیشتر درباره استفاده از تنظیمات سهمیه از محصول API، به مثال «سهمیه پویا» در بالا مراجعه کنید..

برای کسب اطلاعات درباره پیکربندی محصولات API با محدودیت‌های سهمیه، به ایجاد محصولات API مراجعه کنید.

مرجع عنصر

در زیر، عناصر و مشخصه‌هایی را که می‌توانید در این خط‌مشی پیکربندی کنید مشاهده می‌کنید. توجه داشته باشید که برخی‌از ترکیب‌های عنصر به‌صورت متقابل انحصاری هستند یا الزامی نیستند. نمونه‌های استفاده خاص را ببینید. متغیرهای verifyapikey.VerifyAPIKey.apiproduct.* زیر به‌طور پیش‌فرض زمانی دردسترس هستند که از خط‌مشی «درستی‌سنجی کلید API» به‌نام «درستی‌سنجی کلید API» برای بررسی کلید API برنامه در درخواست استفاده شود. مقادیر متغیر از تنظیمات سهمیه در محصول API که کلید با آن مرتبط است، همان‌طور که در دریافت تنظیمات سهمیه از پیکربندی محصول API توضیح داده شده است، می‌آید.

<Quota async="false" continueOnError="false" enabled="true" name="Quota-3" type="calendar">
   <DisplayName>Quota 3</DisplayName>
   <Allow count="2000" countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/>
   <Allow>
      <Class ref="request.queryparam.time_variable">
        <Allow class="peak_time" count="5000"/>
        <Allow class="off_peak_time" count="1000"/>
      </Class>
   </Allow>
   <Interval ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.interval">1</Interval>
   <TimeUnit ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.timeunit">month</TimeUnit>
   <StartTime>2017-7-16 12:00:00</StartTime>
   <Distributed>false</Distributed>
   <Synchronous>false</Synchronous>
   <AsynchronousConfiguration>
      <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
      <SyncMessageCount>5</SyncMessageCount>
   </AsynchronousConfiguration>
   <Identifier/>
   <MessageWeight/>
</Quota>

ویژگی‌های <Quota>

<Quota async="false" continueOnError="false" enabled="true" name="Quota-3" type="calendar">

ویژگی‌های زیر مختص این خط‌مشی است.

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

عنصر <Allow>

حد تعداد را برای سهمیه مشخص می‌کند. اگر شمارنده خط‌مشی به این مقدار برسد، تماس‌های بعدی تا زمانی که شمارنده بازنشانی شود رد می‌شوند.

در زیر سه روش برای تنظیم عنصر <Allow> نشان داده شده است:

<Allow count="2000"/>

<Allow countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/>

<Allow count="2000" countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/>

اگر هم count و هم countRef را مشخص کنید، countRef اولویت دارد. اگر countRef در زمان اجرا حل نشود، از مقدار count استفاده می‌شود.

مشخصه‌ها

عنصر <Allow>/<Class>

عنصر <Class> به شما امکان می‌دهد مقدار عنصر <Allow> را براساس مقدار متغیر جاری‌سازی شرطی کنید. برای هر برچسب کودک <Allow> متفاوت از <Class>، خط‌مشی شمارنده متفاوتی را حفظ می‌کند.

برای استفاده از عنصر <Class>، متغیر جاری را بااستفاده از مشخصه ref به برچسب <Class> مشخص کنید. سپس Edge از مقدار متغیر جاری استفاده می‌کند تا یکی از برچسب‌های فرزند <Allow> را برای تعیین تعداد مجاز خط‌مشی انتخاب کند. ‫Edge مقدار متغیر جاری‌سازی را با مقدار مشخصه class برچسب <Allow> مطابقت می‌دهد، همان‌طور که در زیر نشان داده شده است:

<Allow>
  <Class ref="request.queryparam.time_variable">
    <Allow class="peak_time" count="5000"/>
    <Allow class="off_peak_time" count="1000"/>
  </Class>
</Allow>

در این مثال، شمارنده سهمیه کنونی براساس مقدار پارامتر پُرسمان time_variable ارسال‌شده با هر درخواست تعیین می‌شود. آن متغیر می‌تواند مقدار peak_time یا off_peak_time داشته باشد. اگر پارامتر پُرسمان حاوی مقدار نامعتبر باشد، خط‌مشی خطای نقض سهمیه برمی‌گرداند.

مشخصه‌ها

عنصر <Allow>/<Class>/<Allow>

عنصر <Allow> حد شمارنده سهمیه را که با عنصر <Class> تعریف شده است مشخص می‌کند. برای هر برچسب کودک <Allow> متفاوت از <Class>، خط‌مشی شمارنده متفاوتی را حفظ می‌کند.

برای مثال:

<Allow>
  <Class ref="request.queryparam.time_variable">
    <Allow class="peak_time" count="5000"/>
    <Allow class="off_peak_time" count="1000"/>
  </Class>
</Allow>

در این مثال، خط‌مشی «سهمیه» دو شمارنده سهمیه به نام‌های peak_time و off_peak_time را حفظ می‌کند.

مشخصه‌ها

عنصر <Interval>

برای مشخص کردن عدد صحیح (برای مثال، ۱، ۲، ۵، ۶۰، و غیره) که با TimeUnit مشخص‌شده (دقیقه، ساعت، روز، هفته، یا ماه) جفت می‌شود تا دوره زمانی‌ای را که Edge در آن استفاده از سهمیه را محاسبه می‌کند تعیین کنید.

برای مثال، Interval 24 با TimeUnit hour به این معنی است که سهمیه درطول ۲۴ ساعت محاسبه خواهد شد.

<Interval ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.interval">1</Interval>

مشخصه‌ها

عنصر <TimeUnit>

برای مشخص کردن واحد زمان مربوط به سهمیه استفاده می‌شود.

برای مثال، Interval 24 با TimeUnit hour یعنی سهمیه درطول ۲۴ ساعت محاسبه خواهد شد.

<TimeUnit ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.timeunit">month</TimeUnit>

مشخصه‌ها

عنصر <StartTime>

وقتی type روی calendar, تنظیم می‌شود، تاریخ و زمان شروع شمارشگر سهمیه را مشخص می‌کند، صرف‌نظر از اینکه درخواستی از برنامه‌ای دریافت شده باشد یا نه.

برای مثال:

<StartTime>2017-7-16 12:00:00</StartTime>

عنصر <Distributed>

نصب Edge می‌تواند از یک یا چند «پردازشگر پیام» برای پردازش درخواست‌ها استفاده کند. این عنصر را روی true تنظیم کنید تا مشخص کنید خط‌مشی باید شمارنده مرکزی را حفظ کند و آن را به‌طور مداوم در همه «پردازشگرهای پیام» همگام‌سازی کند. پردازشگرهای پیام می‌توانند در مناطق دردسترس بودن و/یا مناطق مختلف باشند.

اگر از مقدار پیش‌فرض false استفاده کنید، ممکن است از سهمیه خود فراتر بروید زیرا تعداد هر «پردازنده پیام» هم‌رسانی نمی‌شود:

<Distributed>true</Distributed>

برای تضمین اینکه شمارنده‌ها هم‌زمان‌سازی و در هر درخواست به‌روز می‌شوند، <Distributed> و <Synchronous> را روی درست تنظیم کنید:

<Distributed>true</Distributed>
<Synchronous>true</Synchronous>

عنصر <Synchronous>

برای به‌روزرسانی هم‌زمان شمارنده سهمیه توزیع‌شده، روی true تنظیم کنید. این یعنی به‌روزرسانی شمارنده هم‌زمان با بررسی سهمیه در درخواست به API انجام می‌شود. اگر ضروری است که هیچ فراخوانی «میانای برنامه‌سازی کاربردی» فراتر از سهمیه مجاز نباشد، آن را روی true تنظیم کنید.

برای به‌روزرسانی ناهمزمان شمارنده سهمیه، روی false تنظیم کنید. این یعنی ممکن است برخی‌از فراخوانی‌های API که از سهمیه فراتر رفته‌اند انجام شوند، بسته به اینکه شمارنده سهمیه در مخزن مرکزی به‌صورت ناهمزمان به‌روزرسانی شود. بااین‌حال، با تأثیرات احتمالی عملکرد مرتبط با به‌روزرسانی‌های هم‌زمان مواجه نخواهید شد.

فاصله زمانی پیش‌فرض برای به‌روزرسانی ناهم‌زمان ۱۰ ثانیه است. برای پیکربندی این رفتار ناهم‌زمان، از عنصر AsynchronousConfiguration استفاده کنید.

<Synchronous>false</Synchronous>

عنصر <AsynchronousConfiguration>

وقتی عنصر پیکربندی خط‌مشی <Synchronous> وجود نداشته باشد یا وجود داشته باشد و روی false تنظیم شده باشد، فاصله همگام‌سازی بین شمارنده‌های سهمیه توزیع‌شده را پیکربندی می‌کند.

می‌توانید همگام‌سازی را پس‌از یک دوره زمانی یا تعداد پیام انجام دهید، بااستفاده از عناصر فرزند SyncIntervalInSeconds یا SyncMessageCount. این دو مورد متقابلاً انحصاری هستند. برای مثال،

<AsynchronousConfiguration>
   <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
</AsynchronousConfiguration>

یا

<AsynchronousConfiguration>
   <SyncMessageCount>5</SyncMessageCount>
</AsynchronousConfiguration>

عنصر <AsynchronousConfiguration>/<SyncIntervalInSeconds>

از این تنظیم برای ملغی کردن رفتار پیش‌فرض استفاده کنید که در آن به‌روزرسانی‌های ناهم‌زمان پس‌از فاصله زمانی ۱۰ ثانیه انجام می‌شود.

<AsynchronousConfiguration>
   <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
</AsynchronousConfiguration>

فاصله همگام‌سازی باید همان‌طور که در موضوع محدودیت‌ها توضیح داده شده است >= 10 ثانیه باشد.

عنصر <AsynchronousConfiguration>/<SyncMessageCount>

تعداد درخواست‌ها را در همه پردازشگرهای پیام Apigee بین به‌روزرسانی‌های سهمیه مشخص می‌کند.

<AsynchronousConfiguration>
   <SyncMessageCount>5</SyncMessageCount>
</AsynchronousConfiguration>

این مثال مشخص می‌کند که تعداد سهمیه هر ۵ درخواست در هر پردازشگر پیام Apigee Edge به‌روزرسانی می‌شود.

عنصر <Identifier>

از عنصر <Identifier> برای پیکربندی خط‌مشی به‌منظور ایجاد شمارنده‌های منحصربه‌فرد براساس متغیر جاری استفاده کنید.

اگر از این عنصر استفاده نکنید، خط‌مشی از یک شمارنده واحد استفاده می‌کند که دربرابر سهمیه اعمال می‌شود.

این عنصر در پست «انجمن Apigee» زیر نیز مورد بحث قرار گرفته است: شناسه سهمیه در خط‌مشی‌های مختلف.

<Identifier ref="verifyapikey.verify-api-key.client_id"/>

مشخصه‌ها

عنصر <MessageWeight>

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

برای مثال، می‌خواهید پیام‌های POST را دو برابر پیام‌های GET سنگین یا پرهزینه درنظر بگیرید. بنابراین، MessageWeight را برای POST روی ۲ و برای GET روی ۱ تنظیم می‌کنید. حتی می‌توانید MessageWeight را روی ۰ تنظیم کنید تا درخواست روی شمارنده تأثیر نگذارد. در این مثال، اگر سهمیه ۱۰ پیام در دقیقه باشد و MessageWeight برای درخواست‌های POST 2 باشد، سهمیه اجازه می‌دهد در هر بازه ۱۰ دقیقه‌ای ۵ درخواست POST ارسال شود. هرگونه درخواست اضافی، POST یا GET، قبل‌از بازنشانی شمارنده رد می‌شود.

مقدار نشان‌دهنده MessageWeight باید توسط متغیر جاری مشخص شود و می‌تواند از سرایندهای HTTP، پارامترهای پُرسمان، بار XML یا درخواست JSON، یا هر متغیر جاری دیگری استخراج شود. برای مثال، آن را در سرایندی به نام weight تنظیم می‌کنید:

<MessageWeight ref="message_weight"/>

متغیرهای جریان

متغیرهای «جریان» ازپیش‌تعریف‌شده زیر به‌طور خودکار هنگام اجرای خط‌مشی «سهمیه» پر می‌شوند. برای اطلاعات بیشتر درباره متغیرهای «جریان»، مرجع متغیرها را ببینید.

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطایی را که Edge هنگام راه‌اندازی خطا در این خط‌مشی تنظیم می‌کند شرح می‌دهد. این اطلاعات برای دانستن اینکه آیا قوانین خطا را برای مدیریت خطاها توسعه می‌دهید یا نه مهم است. برای کسب اطلاعات بیشتر، آنچه باید درباره خطاهای خط‌مشی بدانیدو رسیدگی به اشکالات را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای خط‌مشی رخ دهند.

خطاهای استقرار

متغیرهای خطا

این متغیرها زمانی تنظیم می‌شوند که این خط‌مشی باعث ایجاد خطا شود. برای اطلاعات بیشتر، آنچه باید درباره خطاهای خط‌مشی بدانیدرا ببینید.

نمونه پاسخ خطا

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      },
      "faultstring":"Rate limit quota violation. Quota limit  exceeded. Identifier : _default"
   }
}

قانون خطای نمونه

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

طرح‌واره‌ها

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

خط‌مشی ResetQuota

خط‌مشی SpikeArrest

مقایسه خط‌مشی‌های سهمیه، توقف ناگهانی، و محدودیت نرخ هم‌زمان