Nutzungskontingent nach Abonnement festlegen

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Die quota-Richtlinie erzwingt ein erneuerbares oder für die Lebensdauer gültiges Aufruf- und/oder Bandbreitenkontingent pro Abonnement. Wenn das Kontingent überschritten wird, erhält der Anrufer einen 403 ForbiddenStatuscode als Antwort. Und die Antwort enthält eine Retry-AfterKopfzeile, deren Wert das empfohlene Wiederholungsintervall in Sekunden ist.

Informationen zu den Unterschieden zwischen Ratenbegrenzungen und Kontingenten finden Sie unter Ratenbegrenzungen und Kontingente.

Hinweis

Wenn zugrunde liegende Computeressourcen auf der Dienstplattform neu gestartet werden, kann API Management auch nach Erreichen eines Kontingents noch für kurze Zeit Anforderungen verarbeiten.

Hinweis

Legen Sie die Elemente und untergeordneten Elemente einer Richtlinie in der Reihenfolge fest, die in der Richtlinienanweisung angegeben ist. Erfahren Sie mehr darüber, wie Sie API Management-Richtlinien festlegen oder bearbeiten.

Richtlinienanweisung

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

Attribute

Attribut BESCHREIBUNG Erforderlich Standard
bandwidth Die maximale Gesamtanzahl von Kilobytes, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
calls Die maximale Gesamtanzahl von Aufrufen, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
renewal-period Die Länge des festen Fensters in Sekunden, nach dem die Quote zurückgesetzt wird. Der Beginn eines jeden Zeitraums wird relativ zur Startzeit des Abonnements berechnet. Wenn der Wert renewal-periodauf gesetzt ist0, wird die Periode auf unendlich gesetzt. Richtlinienausdrücke sind nicht zulässig. Ja –

Elemente

Element BESCHREIBUNG Erforderlich
api Fügen Sie mindestens eines dieser Elemente hinzu, um ein Aufrufkontingent für APIs innerhalb des Produkts zu erzwingen. Produkt- und API-Aufrufkontingente werden unabhängig voneinander angewendet. Auf „api“ kann über name oder id verwiesen werden. Wenn beide Attribute bereitgestellt werden, wird id verwendet und name ignoriert. Nein
operation Fügen Sie mindestens eines dieser Elemente hinzu, um ein Aufrufkontingent für Vorgänge innerhalb einer API zu erzwingen. Aufrufkontingente für Produkte, APIs und Vorgänge werden unabhängig voneinander angewendet. Auf „operation“ kann über name oder id verwiesen werden. Wenn beide Attribute bereitgestellt werden, wird id verwendet und name ignoriert. Nein

API-Attribute

attribute BESCHREIBUNG Erforderlich Standard
name Der Name der API, auf die das Kontingentlimit für Aufrufe angewendet werden soll. Es muss entweder name oder id angegeben werden. –
id Die ID der API, auf die das Aufrufkontingentlimit angewendet werden soll. Es muss entweder name oder id angegeben werden. N/V
bandwidth Die maximale Gesamtanzahl von Kilobytes, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
calls Die maximale Gesamtanzahl von Aufrufen, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
renewal-period Die Länge des festen Fensters in Sekunden, nach dem die Quote zurückgesetzt wird. Der Beginn eines jeden Zeitraums wird relativ zur Startzeit des Abonnements berechnet. Wenn der Wert renewal-periodauf gesetzt ist0, wird die Periode auf unendlich gesetzt. Richtlinienausdrücke sind nicht zulässig. Ja –

Vorgangsattribute

attribute BESCHREIBUNG Erforderlich Standard
name Der Name des Vorgangs, auf den das Kontingentlimit für Aufrufe angewendet werden soll. Es muss entweder name oder id angegeben werden. –
id Die ID des Vorgangs, auf den das Kontingentlimit für Aufrufe angewendet werden soll. Es muss entweder name oder id angegeben werden. N/V
bandwidth Die maximale Gesamtanzahl von Kilobytes, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
calls Die maximale Gesamtanzahl von Aufrufen, die während des in der renewal-period angegebenen Zeitraums zulässig sind. Richtlinienausdrücke sind nicht zulässig. Es müssen entweder calls oder bandwidth oder beide Attribute zusammen angegeben werden. –
renewal-period Die Länge des festen Fensters in Sekunden, nach dem die Quote zurückgesetzt wird. Der Beginn eines jeden Zeitraums wird relativ zur Startzeit des Abonnements berechnet. Wenn der Wert renewal-periodauf gesetzt ist0, wird die Periode auf unendlich gesetzt. Richtlinienausdrücke sind nicht zulässig. Ja –

Verwendung

Hinweise zur Verwendung

  • Diese Richtlinie kann pro Richtliniendefinition nur einmal verwendet werden.
  • Diese Richtlinie wird nur angewendet, wenn mithilfe eines Abonnementschlüssels auf eine API zugegriffen wird.

Beispiel

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

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: