Nastavení kvóty využití podle klíče

  • Článek

PLATÍ PRO: Vývojář | Základní | Standardní | Prémie

Zásady quota-by-key vynucují na základě klíče objem volání z obnovitelných zdrojů nebo doby života nebo kvóty šířky pásma. Klíč může mít libovolnou řetězcovou hodnotu a obvykle se zadává prostřednictvím výrazu zásad. Volitelnou podmínku přírůstku je možné přidat k určení požadavků, které se mají počítat do kvóty. Pokud by více zásad zvýší stejnou hodnotu klíče, zvýší se pouze jednou na požadavek. Při překročení kvóty volající obdrží stavový 403 Forbidden kód odpovědi a odpověď obsahuje hlavičku Retry-After , jejíž hodnota je doporučený interval opakování v sekundách.

Pokud chcete porozumět rozdílu mezi limity sazeb a kvótami, přečtěte si téma Omezení rychlosti a kvóty.

Poznámka:

Když se základní výpočetní prostředky restartují na platformě služby, služba API Management může po dosažení kvóty dál zpracovávat žádosti po krátkou dobu.

Poznámka:

Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách. Portál poskytuje průvodce editorem založeným na formulářích, který vám pomůže s konfigurací této zásady. Přečtěte si další informace o tom, jak nastavit nebo upravit zásady služby API Management.

Prohlášení o zásadách

<quota-by-key calls="number"
              bandwidth="kilobytes"
              renewal-period="seconds"
              increment-condition="condition"
              increment-count="number"
              counter-key="key value"
              first-period-start="date-time" />

Atributy

Atribut Popis Požaduje se Výchozí
bandwidth Maximální celkový počet kilobajtů povolený během časového intervalu zadaného v sadě renewal-period. Výrazy zásad nejsou povolené. Musí být zadána možnost calls, bandwidthnebo obojí společně. –
volá Maximální celkový počet volání povolených během časového intervalu zadaného v sadě renewal-period. Výrazy zásad nejsou povolené. Musí být zadána možnost calls, bandwidthnebo obojí společně. –
counter-key Klíč, který se má použít pro .quota policy Pro každou hodnotu klíče se pro všechny obory, ve kterých je zásada nakonfigurovaná, používá jeden čítač. Výrazy zásad jsou povolené. Yes –
inkrementace podmínky Logický výraz určující, jestli se má požadavek počítat do kvóty (true). Výrazy zásad jsou povolené. No –
inkrement-count Číslo, o které se čítač zvýší na požadavek. Výrazy zásad jsou povolené. No 0
období prodloužení Délka v sekundách pevného okna, po kterém se kvóta resetuje. Začátek každého období se počítá vzhledem k first-period-start. Minimální období: 300 sekund. Pokud renewal-period je nastavena hodnota 0, je tečka nastavena na nekonečné. Výrazy zásad nejsou povolené. Yes –
začátek prvního období Počáteční datum a čas pro období prodloužení kvóty v následujícím formátu: yyyy-MM-ddTHH:mm:ssZ jak je uvedeno standardem ISO 8601. Výrazy zásad nejsou povolené. No 0001-01-01T00:00:00Z

Využití

Poznámky k využití

Hodnota counter-key atributu musí být jedinečná pro všechna rozhraní API v instanci služby API Management, pokud nechcete sdílet celkový součet mezi ostatními rozhraními API.

Příklad

<policies>
    <inbound>
        <base />
        <quota-by-key calls="10000" bandwidth="40000" renewal-period="3600"
                      increment-condition="@(context.Response.StatusCode >= 200 && context.Response.StatusCode < 400)"
                      counter-key="@(context.Request.IpAddress)" />
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

Další informace a příklady této zásady najdete v tématu Pokročilé omezování požadavků ve službě Azure API Management.

Související obsah

Další informace o práci se zásadami najdete v tématech: