Limitation du débit de l’API REST entrante

Pour éviter les demandes API REST entrantes excessives, définissez des règles limitant le nombre de demandes API REST entrantes traitées par heure. Vous pouvez créer des règles pour limiter les demandes pour des utilisateurs spécifiques, des utilisateurs ayant des rôles spécifiques ou tous les utilisateurs.

Remarque :

Au fur et à mesure que les demandes atteignent une instance, chaque nœud maintient un nombre de taux limite par utilisateur. Toutes les 30 secondes, le nombre est validé dans la base de données. Par conséquent, une règle de limite de débit peut ne pas entrer en vigueur pendant 30 secondes maximum.

Priorité de limitation de débit

Si une demande REST API entrante correspond à plusieurs règles de limite de taux pour la même ressource, la priorité de limitation de débit est appliquée comme suit :

• Ensemble de règles pour un seul utilisateur remplace les règles pour tous les utilisateurs et les règles pour les utilisateurs disposant d’un rôle.
• Règles définies pour Les utilisateurs ayant un rôle remplacent les règles pour Tous les utilisateurs.

Dans cet exemple, il existe quatre règles de limite de taux pour la même ressource d’API REST : GET /now/v2/table/incident :

Ces règles de limite de taux sont appliquées dans l’ordre suivant :

1. L’option Limiter les incidents par utilisateur s’applique à l’utilisateur ITIL, qui peut soumettre jusqu’à 10 demandes par heure.
2. Limiter les incidents par administrateur d’importation Le rôle s’applique à chaque utilisateur ayant le rôle import_admin. Chaque utilisateur disposant du rôle import_admin peut soumettre jusqu’à trois demandes par heure.
3. Le rôle Limiter les incidents par itil s’applique à chaque utilisateur disposant du rôle itil. Chaque utilisateur disposant du rôle itil peut soumettre jusqu’à cinq demandes par heure.
4. L’option Limiter les incidents s’applique à tous les utilisateurs. Chaque utilisateur peut soumettre jusqu’à deux demandes par heure.

Lorsque l’utilisateur ITIL effectue la demande GET /now/v2/table/incident, la demande correspond aux critères de trois règles : Limiter les incidents, Limiter les incidents par rôle itil et Limiter les incidents par utilisateur. Seule la règle Limiter les incidents par utilisateur est appliquée, car elle a priorité sur les autres règles. Par conséquent, l’utilisateur ITIL peut soumettre un maximum de 10 demandes par heure.

Si un utilisateur dispose de deux rôles ou plus correspondant aux critères de plusieurs règles de limitation de débit pour une ressource d’API REST, la règle autorisant le nombre de demandes le plus bas s’applique aux demandes de l’utilisateur pour la ressource. Pour les exemples de règles de la figure ci-dessus, supposons que l’utilisateur Abel Tuter a à la fois le rôle import_admin et le rôle itil. Lorsqu’Abel Tuter soumet une demande, celle-ci répond aux critères de la règle Limiter les incidents par rôle administrateur et de la règle Limiter les incidents par rôle itil . Seule la règle Limiter les incidents par rôle administrateur est appliquée, car elle autorise le plus petit nombre de demandes. Par conséquent, Abel Tuter peut soumettre un maximum de trois demandes par heure.

En-têtes de réponse de l’API REST

Vous pouvez générer des demandes REST API entrantes à l’aide du ou d’un Utiliser l’explorateur d’API REST client HTTP, tel que Postman. Si la demande correspond à une règle de limitation des taux, plusieurs en-têtes de réponse HTTP fournissent des informations sur la limitation des taux :

• X-RateLimit-Limit affiche le nombre de demandes autorisées par heure.
• X-RateLimit-Reset affiche le temps Unix jusqu’à la prochaine réinitialisation planifiée.
• X-RateLimit-Rule affiche le sys_id de la règle de limite de taux en cours d’application.

  

Si une demande est refusée parce qu’elle dépasse la limite de taux, le système renvoie un en-tête de réponse Recommencer après en plus des en-têtes de réponse concernant la limitation des taux. L’en-tête de réponse Recommencer après affiche le nombre de secondes après lesquelles vous pouvez réessayer la demande pour éviter de dépasser la limite de taux. La réponse d’erreur suivante est renvoyée :

{
    "error": {
        "message": "Rate limit exceeded",
        "detail": "Rate limit of 10 requests per hour for Table API exceeded"
    },
    "status": "failure"
}

L’état d’une demande refusée est 429 Nombre de demandes de trop.

• Créer une limite de débit de l’API REST entrante
  Créez des règles de limite de taux pour limiter le nombre de demandes REST API entrantes traitées par heure.
• Réinitialiser une limite de taux d’API REST entrante
  Réinitialisez une règle de limite de taux pour réinitialiser le nombre de limites de taux à zéro (0) et supprimer toute violation pour l’heure actuelle.
• Surveiller les nombres et les violations des limites de taux de l’API REST entrante
  Pour déterminer si vous avez défini une règle de limite de taux de manière appropriée, surveillez les nombres et les violations des demandes REST API entrantes qui sont restreintes par la règle.
• Enquêter sur les violations des limites de débit de l’API REST entrante
  Examinez les violations des limites de taux pour déterminer les règles de limite de taux dépassées et les utilisateurs qui dépassent ces limites.