سیاست 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">

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails.

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

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

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

عنصر <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 اختیاری

مرجع خطا

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.

Fault code HTTP status Cause Fix
policies.resetquota.InvalidRLPolicy 500 The Quota policy specified in the <Quota> element of the Reset Quota policy is not defined in the API proxy and thus is not available during the flow. The <Quota> element is mandatory and identifies the target Quota policy whose counter should be updated through the Reset Quota policy.
policies.resetquota.FailedToResolveAllowCountRef N/A The reference to the variable containing the allow count in the <Allow> element of the policy cannot be resolved to a value. This element is mandatory and specifies the amount to decrease the quota counter.
policies.resetquota.FailedToResolveRLPolicy 500 The variable referenced by the ref attribute in the <Quota> element cannot be resolved.

Deployment errors

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

Error name Cause Fix
InvalidCount If the count value specified in the <Allow> element of the Reset Quota Policy is not an integer, then the deployment of the API proxy fails.

طرحواره ها

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

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