Ustawianie limitu przydziału użycia według subskrypcji
DOTYCZY: Wszystkie warstwy usługi API Management
Zasady quota
wymuszają na podstawie subskrypcji limit przydziału wywołań odnawialnych lub okresów istnienia i/lub przepustowości. Po przekroczeniu limitu przydziału obiekt wywołujący otrzymuje 403 Forbidden
kod stanu odpowiedzi, a odpowiedź zawiera Retry-After
nagłówek, którego wartość jest zalecanym interwałem ponawiania prób w sekundach.
Aby zrozumieć różnicę między limitami szybkości i limitami przydziałów, zobacz Limity szybkości i limity przydziału.
Uwaga
Po ponownym uruchomieniu bazowych zasobów obliczeniowych na platformie usługi usługa API Management może nadal obsługiwać żądania przez krótki okres po osiągnięciu limitu przydziału.
Uwaga
Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.
Instrukcja zasad
<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>
Atrybuty
Atrybut | opis | Wymagani | Wartość domyślna |
---|---|---|---|
bandwidth | Maksymalna całkowita liczba kilobajtów dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
Wywołania | Maksymalna całkowita liczba wywołań dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
okres odnowienia | Długość w sekundach stałego okna, po którym zostanie zresetowany limit przydziału. Początek każdego okresu jest obliczany względem godziny rozpoczęcia subskrypcji. Gdy renewal-period jest ustawiona 0 wartość , kropka jest ustawiona na nieskończoną. Wyrażenia zasad nie są dozwolone. |
Tak | Nie dotyczy |
Elementy
Element | opis | Wymagania |
---|---|---|
api | Dodaj co najmniej jeden z tych elementów, aby narzucić limit przydziału wywołań dla interfejsów API w produkcie. Przydziały wywołań produktu i interfejsu API są stosowane niezależnie. Do interfejsu API można odwoływać się za pośrednictwem metody name lub id . Jeśli podano oba atrybuty, id zostaną użyte i name zostaną zignorowane. |
Nie. |
rozdzielnicy | Dodaj co najmniej jeden z tych elementów, aby narzucić limit przydziału wywołań na operacje w interfejsie API. Przydziały wywołań produktu, interfejsu API i operacji są stosowane niezależnie. Do operacji można odwoływać się za pośrednictwem metody name lub id . Jeśli podano oba atrybuty, id zostaną użyte i name zostaną zignorowane. |
Nie. |
atrybuty interfejsu API
Atrybut | opis | Wymagani | Wartość domyślna |
---|---|---|---|
name | Nazwa interfejsu API, dla którego ma być stosowany limit przydziału wywołań. | id Albo name musi być określony. |
Nie dotyczy |
identyfikator | Identyfikator interfejsu API, dla którego ma być stosowany limit przydziału wywołań. | id Albo name musi być określony. |
Nie dotyczy |
bandwidth | Maksymalna całkowita liczba kilobajtów dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
Wywołania | Maksymalna całkowita liczba wywołań dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
okres odnowienia | Długość w sekundach stałego okna, po którym zostanie zresetowany limit przydziału. Początek każdego okresu jest obliczany względem godziny rozpoczęcia subskrypcji. Gdy renewal-period jest ustawiona 0 wartość , kropka jest ustawiona na nieskończoną. Wyrażenia zasad nie są dozwolone. |
Tak | Nie dotyczy |
atrybuty operacji
Atrybut | opis | Wymagani | Wartość domyślna |
---|---|---|---|
name | Nazwa operacji, dla której ma być stosowany limit przydziału wywołań. | id Albo name musi być określony. |
Nie dotyczy |
identyfikator | Identyfikator operacji, dla której ma być stosowany limit przydziału wywołań. | id Albo name musi być określony. |
Nie dotyczy |
bandwidth | Maksymalna całkowita liczba kilobajtów dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
Wywołania | Maksymalna całkowita liczba wywołań dozwolonych w przedziale czasu określonym w obiekcie renewal-period . Wyrażenia zasad nie są dozwolone. |
calls Należy określić wartości , bandwidth lub oba te elementy. |
Nie dotyczy |
okres odnowienia | Długość w sekundach stałego okna, po którym zostanie zresetowany limit przydziału. Początek każdego okresu jest obliczany względem godziny rozpoczęcia subskrypcji. Gdy renewal-period jest ustawiona 0 wartość , kropka jest ustawiona na nieskończoną. Wyrażenia zasad nie są dozwolone. |
Tak | Nie dotyczy |
Użycie
- Sekcje zasad: ruch przychodzący
- Zakresy zasad: produkt
- Bramy: klasyczne, v2, zużycie, self-hosted, obszar roboczy
Uwagi dotyczące użycia
- Te zasady mogą być używane tylko raz na definicję zasad.
- Te zasady są stosowane tylko wtedy, gdy dostęp do interfejsu API jest uzyskiwany przy użyciu klucza subskrypcji.
Przykład
<policies>
<inbound>
<base />
<quota calls="10000" bandwidth="40000" renewal-period="3600" />
</inbound>
<outbound>
<base />
</outbound>
</policies>
Powiązane zasady
Powiązana zawartość
Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz:
- Samouczek: przekształcanie i ochrona interfejsu API
- Dokumentacja zasad dla pełnej listy instrukcji zasad i ich ustawień
- Wyrażenia zasad
- Ustawianie lub edytowanie zasad
- Ponowne używanie konfiguracji zasad
- Repozytorium fragmentów zasad
- Tworzenie zasad przy użyciu rozwiązania Microsoft Copilot na platformie Azure