تعيين الحصة النسبية للاستخدام حسب الاشتراك

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

يفرض النهج quota حجم استدعاءات متجددة أو لمدة بقاء معينة و/أو الحصة النسبية لعرض النطاق الترددي، على أساس كل اشتراك. عند تجاوز الحصة النسبية، يتلقى المتصل 403 Forbiddenرمز حالة استجابة، وتتضمن الاستجابة Retry-After عنوانًا تكون قيمته هي الفاصل الزمني لإعادة المحاولة الموصى به بالثواني.

لفهم الفرق بين حدود المعدلات والحصص، راجع حدود المعدلات والحصص النسبية.

إشعار

عند إعادة تشغيل موارد الحوسبة الأساسية في النظام الأساسي للخدمة، قد تستمر APIM برمجة التطبيقات في معالجة الطلبات لفترة قصيرة بعد الوصول إلى الحصة النسبية.

إشعار

تعيين عناصر النهج والعناصر التابعة بالترتيب الوارد في بيان النهج. تعلم كيفية إعداد نُهج APIM أو تعديلها.

نهج السياسة

<quota calls="number" bandwidth="kilobytes" renewal-period="seconds">
    <api name="API name" id="API id" calls="number">
        <operation name="operation name" id="operation id" calls="number" />
    </api>
</quota>

سمات

السمة ‏‏الوصف مطلوبة افتراضي
bandwidth الحدّ الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
calls الحد الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
renewal-period الطول بالثواني للإطار الثابت الذي يتم بعده إعادة تعيين الحصة النسبية. يتم حساب بداية كل فترة بالنسبة إلى وقت بدء الاشتراك. عندما renewal-periodيتم تعيينها إلى 0، يتم تعيين الفترة إلى فترة لا نهائية. تعبيرات النهج غير مسموح بها. ‏‏نعم‬ غير متوفر

عناصر

العنصر الوصف مطلوب
واجهة برمجة التطبيقات إضافة عنصر أو أكثر من هذه العناصر لفرض الحصة النسبية للاستدعاءات في واجهات برمجة التطبيقات ضمن المنتج. يتم تطبيق الحصص النسبية لاستدعاء واجهة برمجة التطبيقات للنظام والمنتج بشكل مستقل. يمكن الرجوع إلى واجهة برمجة التطبيقات إما عبر name أو id. في حالة وجود كلا السمتين، سيتم استخدام id، وسيتم تجاهل name. لا
‏‏التشغيل إضافة عنصر أو أكثر من هذه العناصر لفرض الحصة النسبية للاستدعاءات في العمليات ضمن واجهة برمجة التطبيقات. يتم تطبيق الحصص النسبية للاستدعاءات للمنتج وواجهة برمجة التطبيقات والعملية بشكل مستقل. يمكن الرجوع إلى العملية إما عبر name أو id. في حالة وجود كلا السمتين، سيتم استخدام id، وسيتم تجاهل name. لا

سمات واجهة برمجة التطبيقات

السمة ‏‏الوصف مطلوبة افتراضي
الاسم اسم واجهة برمجة التطبيقات التي سيتم تطبيق حد الحصة النسبية للاتصال بها. إما name أو id يجب تحديده. ‏‫غير متوفر‬
المعرف معرف واجهة برمجة التطبيقات الذي يجب تطبيق حد الحصة النسبية للاتصال له. إما name أو id يجب تحديده. ‏‫غير متوفر‬
bandwidth الحدّ الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
calls الحد الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
renewal-period الطول بالثواني للإطار الثابت الذي يتم بعده إعادة تعيين الحصة النسبية. يتم حساب بداية كل فترة بالنسبة إلى وقت بدء الاشتراك. عندما renewal-periodيتم تعيينها إلى 0، يتم تعيين الفترة إلى فترة لا نهائية. تعبيرات النهج غير مسموح بها. ‏‏نعم‬ غير متوفر

سمات العملية

السمة ‏‏الوصف مطلوبة افتراضي
الاسم اسم العملية التي سيتم تطبيق حد الحصة النسبية للاتصال عليها. إما name أو id يجب تحديده. ‏‫غير متوفر‬
المعرف معرف العملية التي يجب تطبيق حد الحصة النسبية للاتصال عليها. إما name أو id يجب تحديده. ‏‫غير متوفر‬
bandwidth الحدّ الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
calls الحد الأقصى لإجمالي عدد المكالمات المسموح بها خلال الفاصل الزمني المحدد في renewal-period. تعبيرات النهج غير مسموح بها. يجب تحديد إما calls، أو bandwidth، أو كلاهما معًا. ‏‫غير متوفر‬
renewal-period الطول بالثواني للإطار الثابت الذي يتم بعده إعادة تعيين الحصة النسبية. يتم حساب بداية كل فترة بالنسبة إلى وقت بدء الاشتراك. عندما renewal-periodيتم تعيينها إلى 0، يتم تعيين الفترة إلى فترة لا نهائية. تعبيرات النهج غير مسموح بها. ‏‏نعم‬ غير متوفر

الاستخدام

ملاحظات الاستخدام

  • يمكن استخدام هذا النهج مرة واحدة فقط لكل تعريف نهج.
  • يتم تطبيق هذا النهج فقط عند الوصول إلى واجهة برمجة التطبيقات باستخدام مفتاح اشتراك.

مثال

<policies>
    <inbound>
        <base />
        <quota calls="10000" bandwidth="40000" renewal-period="3600" />
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

لمزيد من المعلومات حول العمل مع النُهج، راجع: