Limitation du taux de l’API REST entrante

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

Remarque :

Lorsque les demandes atteignent une instance, chaque nœud maintient un nombre de limites de taux 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 taux peut ne pas prendre effet pendant 30 secondes maximum.

Priorité de limitation des taux

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

• Règles définies pour Utilisateur unique Règles de remplacement pour Tous les utilisateurs et règles pour Utilisateurs avec rôle.
• Règles définies pour les utilisateurs avec des règles de remplacement de rôle 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 limites de taux sont appliquées dans l’ordre suivant :

1. 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 disposant du 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. Limiter les incidents s’applique à tous les utilisateurs. Chaque utilisateur peut soumettre jusqu’à deux demandes par heure.

Lorsque l’utilisateur ITIL crée 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 faible 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 dispose à la fois du rôle import_admin et du rôle ITIL. Lorsqu’Abel Tuter envoie une demande, elle 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 REST API

Vous pouvez générer des demandes REST API entrantes à l’aide de ou Utiliser l’explorateur d’API REST d’un client HTTP, tel que Postman. Si la demande correspond à une règle de limite de 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 des taux, le système renvoie un en-tête de réponse Recommencer après en plus des en-têtes de réponse sur la limitation des taux. L’en-tête de réponse Recommencer après affiche le nombre de secondes après lesquelles vous pouvez relancer la demande pour éviter de dépasser la limite des 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 Trop de demandes.

• Créer une limite de taux d’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établir le nombre de limites de taux sur zéro (0) et supprimer toute violation pour l’heure en cours.
• Surveiller le nombre de limites de taux de l’API REST entrante et les violations
  Pour déterminer si vous avez correctement défini une règle de limite de taux, surveillez le nombre et les violations des demandes REST API entrantes qui sont limitées par la règle.
• Enquêter sur les violations de la limite de taux de l’API REST entrante
  Enquêtez sur les violations des limites de taux pour déterminer quelles règles de limite de taux sont dépassées et quels utilisateurs dépassent ces limites de taux.