Nastavení kvóty využití podle předplatného

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Zásady quota vynucují na základě předplatného objem volání z obnovitelných zdrojů nebo doby života nebo kvóty šířky pásma. 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. 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 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>

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ání 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ě. –
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 počátečnímu času předplatného. Pokud renewal-period je nastavena na 0hodnotu , tečka je nastavena na nekonečné. Výrazy zásad nejsou povolené. Yes –

Elementy

Element (Prvek) Popis Povinní účastníci
api Přidejte jeden nebo více těchto prvků, aby se kvóta volání uložila na rozhraní API v rámci produktu. Kvóty volání produktů a rozhraní API se použijí nezávisle. Na rozhraní API lze odkazovat prostřednictvím name nebo id. Pokud jsou k dispozici oba atributy, id budou použity a name budou ignorovány. No
operation Přidejte jeden nebo více těchto prvků, které zavedou kvótu volání pro operace v rámci rozhraní API. Kvóty volání produktů, rozhraní API a operací se použijí nezávisle. Operaci lze odkazovat buď prostřednictvím name , nebo id. Pokud jsou k dispozici oba atributy, id budou použity a name budou ignorovány. No

atributy rozhraní API

Atribut Popis Požaduje se Výchozí
name Název rozhraní API, pro které se má použít limit kvóty volání. Musí name být zadána nebo id musí být zadána. –
ID ID rozhraní API, pro které se má použít limit kvóty volání. Musí name být zadána nebo id musí být zadána. –
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ání 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ě. –
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 počátečnímu času předplatného. Pokud renewal-period je nastavena na 0hodnotu , tečka je nastavena na nekonečné. Výrazy zásad nejsou povolené. Yes –

atributy operace

Atribut Popis Požaduje se Výchozí
name Název operace, pro kterou se má použít limit kvóty volání. Musí name být zadána nebo id musí být zadána. –
ID ID operace, pro kterou se má použít limit kvóty volání. Musí name být zadána nebo id musí být zadána. –
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ání 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ě. –
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 počátečnímu času předplatného. Pokud renewal-period je nastavena na 0hodnotu , tečka je nastavena na nekonečné. Výrazy zásad nejsou povolené. Yes –

Využití

Poznámky k využití

  • Tuto zásadu lze použít pouze jednou pro každou definici zásady.
  • Tato zásada se použije jenom v případě, že k rozhraní API přistupujete pomocí klíče předplatného.

Příklad

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

Související obsah

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