سیاست ResetQuota

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

چی

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

به عنوان مثال، سیاست سهمیه هدف، یک برنامه‌نویس را به 1000 درخواست در هفته محدود می‌کند. تا روز دوم هفته، توسعه دهنده قبلاً به این حد رسیده است. از خط مشی Reset Quota برای کم کردن 500 از شمارنده سهمیه آنها استفاده کنید تا 500 درخواست اضافی برای باقیمانده هفته مجاز شود. در پایان هفته، خط مشی Quota بازنشانی می‌شود و توسعه‌دهنده به 1000 درخواست برای هفته بازگشته است.

برای اطلاعات بیشتر در مورد خط مشی سهمیه به خط مشی سهمیه مراجعه کنید. همچنین این پست انجمن را در مورد استفاده از سیاست بازنشانی سهمیه مشاهده کنید.

نمونه ها

این نمونه‌های کد خط‌مشی نحوه بازنشانی شمارنده‌های سهمیه را نشان می‌دهند:

تنظیم مجدد شمارنده پیش فرض

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

خط مشی Reset Quota با استفاده از ویژگی نام تگ <Quota> خط مشی سهمیه هدف را مشخص می کند. در مثال بالا، سیاست MyQuotaPolicy هدف است.

همه سیاست‌های Reset Quota به برچسب <Identifier> نیاز دارند تا شمارنده را در خط مشی Quota برای به‌روزرسانی مشخص کند. به طور پیش فرض، یک خط مشی Quota دارای یک شمارنده است، مگر اینکه خط مشی Quota شامل تگ <Identifier> نیز باشد. در این مثال، خط مشی Quota هدف از تگ <Identifier> استفاده نمی کند، بنابراین شما ویژگی نام را به عنوان _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>

در این مثال، نام خط مشی سهمیه هدف و تغییر تعداد سهمیه آن را به عنوان سرصفحه در درخواست ارسال می کنید. سپس می توانید به متغیرهای جریان حاوی این مقادیر در خط مشی Reset Quota ارجاع دهید.

شناسه را مشخص کنید

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

اگر خط مشی Quota هدف تگ <Identifier> را مشخص می کند، می توانید همان مقدار را برای برچسب <Identifier> خط مشی Reset Quota تعیین کنید تا تعداد سهمیه خاصی به روز شود. توجه داشته باشید که چگونه تگ <Identifier> در خط مشی سهمیه هدف زیر با مقدار مشخص شده با خط مشی Reset Quota مطابقت دارد:

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

مرجع عنصر

مرجع عنصر عناصر و ویژگی های خط مشی Reset 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> برای برچسب گذاری خط مشی در ویرایشگر پروکسی UI مدیریت با نامی به زبان طبیعی دیگر استفاده کنید.

N/A مورد نیاز
continueOnError

برای بازگرداندن خطا در صورت شکست خط مشی، روی false تنظیم کنید. این رفتار مورد انتظار برای اکثر سیاست ها است.

روی true تنظیم کنید تا اجرای جریان حتی پس از شکست خط مشی ادامه یابد.

نادرست اختیاری
enabled

برای اجرای خط مشی روی true تنظیم کنید.

برای خاموش کردن خط مشی، روی false تنظیم کنید. این سیاست حتی اگر به یک جریان وابسته باشد اجرا نخواهد شد.

درست است اختیاری
async

این ویژگی منسوخ شده است.

نادرست منسوخ شده است

عنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>
پیش فرض

N/A

اگر این عنصر را حذف کنید، از مقدار ویژگی name خط مشی استفاده می شود.

حضور اختیاری
تایپ کنید رشته

عنصر <Quota>

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

<Quota name="quotaName"  ref="request.header.quotapolicy">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
پیش فرض: N/A
حضور: مورد نیاز
نوع: N/A

صفات

صفت توضیحات پیش فرض حضور
نام

نام خط مشی سهمیه هدف را مشخص می کند.

N/A اختیاری
رجوع کنید یک متغیر جریان که حاوی نام خط مشی سهمیه هدف است. اگر هم ref و هم نام مشخص شده باشد، ref اولویت دارد. اگر ref در زمان اجرا حل نشد، از نام استفاده می شود. N/A اختیاری

عنصر <Quota>/<Identifier>

اگر خط مشی Quota هدف تگ <Identifier> را مشخص کند، متغیر برای شناسایی منحصر به فرد شمارنده استفاده می شود.

<Quota name="quotaName">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
پیش فرض: N/A
حضور: مورد نیاز
نوع: رشته

صفات

صفت توضیحات پیش فرض حضور
نام

نام شناسه تعداد را در خط مشی سهمیه هدف مشخص می کند. برای یک خط مشی Quota که از تگ <Identifier> استفاده نمی کند، _default را مشخص کنید.

N/A اختیاری
رجوع کنید

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

N/A اختیاری

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

مقدار کاهش سهمیه شمار را مشخص می کند. شما باید <Allow> را مشخص کنید، در غیر این صورت، این خط مشی سهمیه را تغییر نمی دهد.

<Identifier name="identifierName" ref="request.header.identifier">
   <Allow ref="request.header.allowquota">100</Allow>
</Identifier>
پیش فرض: N/A
حضور: مورد نیاز
نوع: عدد صحیح

صفات

صفت توضیحات پیش فرض حضور
رجوع کنید

یک متغیر جریان که شامل تغییر تعداد سهمیه در خط مشی سهمیه هدف است.

N/A اختیاری

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

کلاسی را مشخص می کند که شمارنده Quota برای آن به روز می شود. برای اطلاعات بیشتر در مورد استفاده از کلاس با خط مشی Quota، به خط مشی Quota مراجعه کنید.

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
پیش فرض: N/A
حضور: اختیاری
نوع: N/A

صفات

صفت توضیحات پیش فرض حضور
رجوع کنید

به متغیر جریانی که شامل کلاس سهمیه برای به روز رسانی است، مراجعه کنید.

N/A اختیاری

مرجع خطا

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

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

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

کد خطا وضعیت HTTP علت ثابت
policies.resetquota.InvalidRLPolicy 500 خط مشی Quota مشخص شده در عنصر <Quota> خط مشی Reset Quota در پراکسی API تعریف نشده است و بنابراین در طول جریان در دسترس نیست. عنصر <Quota> اجباری است و خط مشی سهمیه هدف را مشخص می کند که شمارنده آن باید از طریق خط مشی Reset Quota به روز شود.
policies.resetquota.FailedToResolveAllowCountRef N/A ارجاع به متغیر حاوی تعداد مجاز در عنصر <Allow> سیاست را نمی توان به مقدار تعیین کرد. این عنصر اجباری است و میزان کاهش سهمیه شمار را مشخص می کند.
policies.resetquota.FailedToResolveRLPolicy 500 متغیر ارجاع شده توسط ویژگی ref در عنصر <Quota> قابل حل نیست.

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

این خطاها ممکن است زمانی رخ دهند که یک پروکسی حاوی این خط مشی را مستقر می کنید.

نام خطا علت ثابت
InvalidCount اگر مقدار شمارش مشخص شده در عنصر <Allow> سیاست Reset Quota یک عدد صحیح نباشد، استقرار پراکسی API با شکست مواجه می‌شود.

طرحواره ها

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

سیاست سهمیه بندی