Ange användningskvot per prenumeration
GÄLLER FÖR: Alla API Management-nivåer
Principen quota
tillämpar en kvot för anrop för förnybar eller livslängd och/eller bandbreddskvot per prenumeration. När kvoten överskrids får anroparen en 403 Forbidden
svarsstatuskod och svaret innehåller en Retry-After
rubrik vars värde är det rekommenderade återförsöksintervallet i sekunder.
Information om skillnaden mellan hastighetsgränser och kvoter finns i Hastighetsgränser och kvoter.
Kommentar
När underliggande beräkningsresurser startas om på tjänstplattformen kan API Management fortsätta att hantera begäranden under en kort period efter att en kvot har nåtts.
Kommentar
Ange principens element och underordnade element i den ordning som anges i principbeskrivningen. Läs mer om hur du anger eller redigerar API Management-principer.
Principuttryck
<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>
Attribut
Attribut | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
bandwidth | Det maximala totala antalet kilobyte som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
Samtal | Det maximala totala antalet anrop som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
förnyelseperiod | Längden i sekunder för det fasta fönstret varefter kvoten återställs. Starten av varje period beräknas i förhållande till prenumerationens starttid. När renewal-period är inställt på 0 är perioden inställd på oändlig. Principuttryck tillåts inte. |
Ja | Ej tillämpligt |
Element
Element | Description | Obligatoriskt |
---|---|---|
api | Lägg till ett eller flera av dessa element för att införa anropskvot för API:er i produkten. Kvoter för produkt- och API-anrop tillämpas oberoende av varandra. API kan refereras antingen via name eller id . Om båda attributen anges id används och name ignoreras. |
Nej |
operation | Lägg till ett eller flera av dessa element för att införa anropskvot för åtgärder i ett API. Kvoter för produkt-, API- och åtgärdsanrop tillämpas oberoende av varandra. Åtgärden kan refereras antingen via name eller id . Om båda attributen anges id används och name ignoreras. |
Nej |
api-attribut
Attribut | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
name | Namnet på API:et för vilket anropskvotgränsen ska tillämpas. | Antingen name eller id måste anges. |
Ej tillämpligt |
id | ID:t för API:et för vilket anropskvotgränsen ska tillämpas. | Antingen name eller id måste anges. |
Ej tillämpligt |
bandwidth | Det maximala totala antalet kilobyte som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
Samtal | Det maximala totala antalet anrop som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
förnyelseperiod | Längden i sekunder för det fasta fönstret varefter kvoten återställs. Starten av varje period beräknas i förhållande till prenumerationens starttid. När renewal-period är inställt på 0 är perioden inställd på oändlig. Principuttryck tillåts inte. |
Ja | Ej tillämpligt |
åtgärdsattribut
Attribut | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
name | Namnet på den åtgärd som anropskvotgränsen ska tillämpas för. | Antingen name eller id måste anges. |
Ej tillämpligt |
id | ID för den åtgärd för vilken anropskvotgränsen ska tillämpas. | Antingen name eller id måste anges. |
Ej tillämpligt |
bandwidth | Det maximala totala antalet kilobyte som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
Samtal | Det maximala totala antalet anrop som tillåts under tidsintervallet som anges i renewal-period . Principuttryck tillåts inte. |
Antingen calls , bandwidth eller båda tillsammans måste anges. |
Ej tillämpligt |
förnyelseperiod | Längden i sekunder för det fasta fönstret varefter kvoten återställs. Starten av varje period beräknas i förhållande till prenumerationens starttid. När renewal-period är inställt på 0 är perioden inställd på oändlig. Principuttryck tillåts inte. |
Ja | Ej tillämpligt |
Förbrukning
- Principavsnitt: inkommande
- Principomfattningar: produkt
- Gatewayer: klassisk, v2, förbrukning, lokalt installerad, arbetsyta
Användningsanteckningar
- Den här principen kan bara användas en gång per principdefinition.
- Den här principen tillämpas endast när ett API används med hjälp av en prenumerationsnyckel.
Exempel
<policies>
<inbound>
<base />
<quota calls="10000" bandwidth="40000" renewal-period="3600" />
</inbound>
<outbound>
<base />
</outbound>
</policies>
Relaterade principer
Relaterat innehåll
Mer information om hur du arbetar med principer finns i:
- Självstudie: Transformera och skydda ditt API
- Principreferens för en fullständig lista över principinstruktioner och deras inställningar
- Principuttryck
- Ange eller redigera principer
- Återanvända principkonfigurationer
- Lagringsplats för principfragment
- Principverktyg för Azure API Management
- Skapa principer med Microsoft Copilot i Azure