Set usage quota by subscription

  • Article

S’APPLIQUE À : Tous les niveaux de Gestion des API

La stratégie quota applique un volume d’appels et/ou un quota de bande passante renouvelable ou illimité par abonnement. Lorsque le quota est dépassé, l’appelant reçoit un code d’état de réponse 403 Forbidden, et la réponse inclut un en-tête Retry-Afterdont la valeur est l’intervalle de nouvelle tentative recommandé en secondes.

Pour comprendre la différence entre les limites de taux et les quotas, consultez Limites de taux et quotas.

Notes

Quand les ressources de calcul sous-jacentes redémarrent dans la plateforme de service, Gestion des API peut continuer à gérer les requêtes pendant une courte période après qu’un quota est atteint.

Notes

Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.

Instruction de la stratégie

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

Attributs

Attribut Description Obligatoire Default
bandwidth Nombre maximal de kilo-octets autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
calls Nombre maximal d’appels autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
renewal-period Durée en secondes de la fenêtre fixe après laquelle le quota est réinitialisé. Le début de chaque période est calculé par rapport à l’heure de début de l’abonnement. Quand la valeur renewal-period est définie sur 0, la période est définie sur Infini. Les expressions de stratégie ne sont pas autorisées. Oui N/A

Éléments

Élément Description Obligatoire
api Ajoutez un ou plusieurs éléments de ce type pour imposer un quota d’appel aux API au sein du produit. Les quotas d’appel au niveau du produit et de l’API s’appliquent indépendamment les uns des autres. L’API peut être référencée via name ou id. Si les deux attributs sont fournis, id sera utilisé et name sera ignoré. Non
operation Ajoutez un ou plusieurs éléments de ce type pour imposer un quota d’appel aux opérations au sein d’une API. Les quotas d’appel au niveau du produit, de l’API et de l’opération s’appliquent indépendamment les uns des autres. L’opération peut être référencée via name ou id. Si les deux attributs sont fournis, id sera utilisé et name sera ignoré. Non

Attributs API

Attribut Description Obligatoire Default
name Nom de l’API à laquelle la limite de quota d’appels s’applique. name ou id doit être spécifié. N/A
id ID de l’API à laquelle la limite de quota d’appels s’applique. Soit name, soit id doit être spécifié. N/A
bandwidth Nombre maximal de kilo-octets autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
calls Nombre maximal d’appels autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
renewal-period Durée en secondes de la fenêtre fixe après laquelle le quota est réinitialisé. Le début de chaque période est calculé par rapport à l’heure de début de l’abonnement. Quand la valeur renewal-period est définie sur 0, la période est définie sur Infini. Les expressions de stratégie ne sont pas autorisées. Oui N/A

Attributs opération

Attribut Description Obligatoire Default
name Le nom de l’opération à laquelle la limite de quota d’appels s’applique. name ou id doit être spécifié. N/A
id L’ID de l’opération à laquelle la limite de quota d’appels s’applique. name ou id doit être spécifié. N/A
bandwidth Nombre maximal de kilo-octets autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
calls Nombre maximal d’appels autorisés au cours de l’intervalle de temps spécifié dans le paramètre renewal-period. Les expressions de stratégie ne sont pas autorisées. Il est obligatoire de spécifier calls, bandwidth ou les deux. N/A
renewal-period Durée en secondes de la fenêtre fixe après laquelle le quota est réinitialisé. Le début de chaque période est calculé par rapport à l’heure de début de l’abonnement. Quand la valeur renewal-period est définie sur 0, la période est définie sur Infini. Les expressions de stratégie ne sont pas autorisées. Oui N/A

Usage

Notes d’utilisation

  • Cette stratégie ne peut être utilisée qu’une seule fois par définition de stratégie.
  • Cette stratégie est appliquée uniquement lorsqu’une API est accessible à l’aide d’une clé d’abonnement.

Exemple

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

Contenu connexe

Pour plus d’informations sur l’utilisation des stratégies, consultez :