Imposta quota di utilizzo per sottoscrizione

  • Articolo

SI APPLICA A: Tutti i livelli di Gestione API

Il criterio quota consente di applicare una quota rinnovabile o permanente per il volume di chiamate e/o per la larghezza di banda, per sottoscrizione. Quando viene superata la quota, il chiamante riceve un codice di stato della risposta 403 Forbidden e la risposta include un'intestazione Retry-After il cui valore è l'intervallo di tentativi consigliato in secondi.

Per comprendere la differenza tra limiti di velocità e quote, vedere Limiti di frequenza e quote.

Nota

Quando le risorse di calcolo sottostanti si riavviano nella piattaforma del servizio, Gestione API può continuare a gestire le richieste per un breve periodo dopo il raggiungimento di una quota.

Nota

Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione dei criteri. Altre informazioni su come impostare o modificare i criteri di Gestione API.

Istruzione del criterio

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

Attributi

Attributo Descrizione Richiesto Valore predefinito
bandwidth Il numero totale massimo di kilobyte consentiti durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
calls Il numero totale massimo di chiamate consentite durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
renewal-period Lunghezza in secondi della finestra fissa dopo la quale viene reimpostata la quota. L'inizio di ogni periodo viene calcolato in relazione all'ora di inizio della sottoscrizione. Quando renewal-period è impostato su 0, il periodo viene impostato su infinito. Le espressioni di criteri non sono consentite. Sì N/D

Elementi

Elemento Descrizione Richiesto
api Aggiungere almeno uno di questi elementi per imporre una quota di chiamate API all'interno del prodotto. Le quote di chiamate API e del prodotto vengono applicate in modo indipendente. È possibile fare riferimento all'API tramite name o id. Se vengono specificati entrambi gli attributi, verrà usato id e name verrà ignorato. No
operation (operazione) Aggiungere almeno uno di questi elementi per imporre una quota di chiamate per le operazioni all'interno di un'API. Le quote di chiamate per le operazioni, l'API e il prodotto vengono applicate in modo indipendente. È possibile fare riferimento all'operazione tramite name o id. Se vengono specificati entrambi gli attributi, verrà usato id e name verrà ignorato. No

attributi api

Attributo Descrizione Richiesto Valore predefinito
name Nome dell'API per cui applicare il limite di quota di chiamata. È necessario specificare name o id. N/D
id ID dell'API per cui applicare il limite di quota di chiamata. È necessario specificare name o id. N/D
bandwidth Il numero totale massimo di kilobyte consentiti durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
calls Il numero totale massimo di chiamate consentite durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
renewal-period Lunghezza in secondi della finestra fissa dopo la quale viene reimpostata la quota. L'inizio di ogni periodo viene calcolato in relazione all'ora di inizio della sottoscrizione. Quando renewal-period è impostato su 0, il periodo viene impostato su infinito. Le espressioni di criteri non sono consentite. Sì N/D

attributi dell'operazione

Attributo Descrizione Richiesto Valore predefinito
name Nome dell'operazione per cui applicare il limite di quota di chiamata. È necessario specificare name o id. N/D
id ID dell'operazione per cui applicare il limite di quota di chiamata. È necessario specificare name o id. N/D
bandwidth Il numero totale massimo di kilobyte consentiti durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
calls Il numero totale massimo di chiamate consentite durante l'intervallo di tempo specificato in renewal-period. Le espressioni di criteri non sono consentite. Devono essere specificati calls, bandwidth o entrambi. N/D
renewal-period Lunghezza in secondi della finestra fissa dopo la quale viene reimpostata la quota. L'inizio di ogni periodo viene calcolato in relazione all'ora di inizio della sottoscrizione. Quando renewal-period è impostato su 0, il periodo viene impostato su infinito. Le espressioni di criteri non sono consentite. Sì N/D

Utilizzo

Note sull'utilizzo

  • Questo criterio può essere impiegato una sola volta per ogni definizione di criterio.
  • Questo criterio viene applicato solo quando si accede a un'API usando una chiave di sottoscrizione.

Esempio

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

Contenuto correlato

Per ulteriori informazioni sull'utilizzo dei criteri, vedere: