Gebruiksquotum instellen per abonnement

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

Het quota beleid dwingt een aanroepvolume en/of bandbreedtequotum voor hernieuwbare of levensduur af, op basis van een abonnement. Wanneer het quotum wordt overschreden, ontvangt de aanroeper een 403 Forbidden antwoordstatuscode en bevat het antwoord een Retry-After header waarvan de waarde het aanbevolen interval voor opnieuw proberen is in seconden.

Zie Frequentielimieten en quota voor meer informatie over het verschil tussen frequentielimieten en quota .

Notitie

Wanneer onderliggende rekenresources opnieuw worden opgestart in het serviceplatform, kan API Management aanvragen gedurende een korte periode blijven verwerken nadat een quotum is bereikt.

Notitie

Stel de elementen en onderliggende elementen van het beleid in de volgorde in die in de beleidsverklaring is opgegeven. Meer informatie over het instellen of bewerken van API Management-beleid.

Beleidsinstructie

<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>

Kenmerken

Kenmerk Beschrijving Vereist Standaardinstelling
bandwidth Het maximumaantal kilobytes dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
Oproepen Het maximumaantal aanroepen dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
verlengingsperiode De lengte in seconden van het vaste venster waarna het quotum opnieuw wordt ingesteld. Het begin van elke periode wordt berekend ten opzichte van de begintijd van het abonnement. Wanneer renewal-period deze is ingesteld 0op , wordt de periode ingesteld op oneindig. Beleidsexpressies zijn niet toegestaan. Ja N.v.t.

Elementen

Element Beschrijving Vereist
api Voeg een of meer van deze elementen toe om een aanroepquotum op te leggen voor API's binnen het product. Quota voor product- en API-aanroepen worden onafhankelijk toegepast. Er kan naar de API worden verwezen via name of id. Als beide kenmerken worden opgegeven, id worden deze gebruikt en name genegeerd. Nee
schakelapparatuur optimaliseren Voeg een of meer van deze elementen toe om een aanroepquotum op te leggen voor bewerkingen binnen een API. Quota voor aanroepen van producten, API's en bewerkingen worden onafhankelijk toegepast. Er kan naar een bewerking worden verwezen via name of id. Als beide kenmerken worden opgegeven, id worden deze gebruikt en name genegeerd. Nee

API-kenmerken

Kenmerk Beschrijving Vereist Standaardinstelling
naam De naam van de API waarvoor de quotumlimiet voor aanroepen moet worden toegepast. id Of name moet worden opgegeven. N.v.t.
id De id van de API waarvoor de quotumlimiet voor aanroepen moet worden toegepast. id Of name moet worden opgegeven. N.v.t.
bandwidth Het maximumaantal kilobytes dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
Oproepen Het maximumaantal aanroepen dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
verlengingsperiode De lengte in seconden van het vaste venster waarna het quotum opnieuw wordt ingesteld. Het begin van elke periode wordt berekend ten opzichte van de begintijd van het abonnement. Wanneer renewal-period deze is ingesteld 0op , wordt de periode ingesteld op oneindig. Beleidsexpressies zijn niet toegestaan. Ja N.v.t.

bewerkingskenmerken

Kenmerk Beschrijving Vereist Standaardinstelling
naam De naam van de bewerking waarvoor de quotumlimiet voor aanroepen moet worden toegepast. id Of name moet worden opgegeven. N.v.t.
id De id van de bewerking waarvoor de quotumlimiet voor aanroepen moet worden toegepast. id Of name moet worden opgegeven. N.v.t.
bandwidth Het maximumaantal kilobytes dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
Oproepen Het maximumaantal aanroepen dat is toegestaan tijdens het tijdsinterval dat is opgegeven in de renewal-period. Beleidsexpressies zijn niet toegestaan. Beide calls, bandwidthof beide moeten worden opgegeven. N.v.t.
verlengingsperiode De lengte in seconden van het vaste venster waarna het quotum opnieuw wordt ingesteld. Het begin van elke periode wordt berekend ten opzichte van de begintijd van het abonnement. Wanneer renewal-period deze is ingesteld 0op , wordt de periode ingesteld op oneindig. Beleidsexpressies zijn niet toegestaan. Ja N.v.t.

Gebruik

Gebruiksnotities

  • Dit beleid kan slechts eenmaal per beleidsdefinitie worden gebruikt.
  • Dit beleid wordt alleen toegepast wanneer een API wordt geopend met behulp van een abonnementssleutel.

Opmerking

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

Gerelateerde inhoud

Zie voor meer informatie over het werken met beleid: