Créer une limite de taux de l’API REST entrante

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • Créez des règles de limite de taux pour limiter le nombre de demandes REST API entrantes traitées par heure.

    Avant de commencer

    Rôle requis : rate_limit_admin

    Pourquoi et quand exécuter cette tâche

    Définissez des limites de taux pour tous les utilisateurs, les utilisateurs ayant des rôles spécifiques ou tous les utilisateurs.
    Remarque :
    Lorsque les demandes atteignent une instance, chaque nœud maintient une limite 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.

    Procédure

    1. Accédez à la Tout > Services web du système > REST > Règles de limites de taux.
    2. Cliquez sur Nouveau et entrez les valeurs de champ suivantes.
      Tableau 1. Formulaire Règle de limite de taux de l’API REST
      Champ Description
      Ressource d'API REST Valeur dérivée des valeurs saisies dans les champs suivants.
      Nom Nom unique de la règle de limite de taux.
      API REST API REST sélectionnée dans la liste de toutes les API REST externes pour l’instance.
      Version Version de REST API. Les valeurs répertoriées dépendent de l’API REST sélectionnée.
      Ressource Ressource pour la version. Les valeurs répertoriées dépendent de la version sélectionnée.
      Table Table que vous souhaitez cibler. S’affiche uniquement lorsque vous sélectionnez l’API de table en tant qu’API REST.
      Table des ensembles de données à importer Table de jeux d’importation que vous souhaitez cibler. Il s’affiche uniquement, vous sélectionnez l’API de jeu d’importation en tant qu’API REST.
      Actif Case à cocher permettant d’indiquer que la règle de limite de taux est active.

      Les règles de limite de taux sont activées par défaut dès que vous les créez. Vous pouvez désactiver les règles de limite de taux pour arrêter l’application d’une limite de taux ou activer les règles de limite de taux pour reprendre l’application d’une limite de taux.

      Limite de demandes par heure Nombre maximal de demandes autorisées par heure.
      Remarque :
      Chaque fois que vous mettez à jour la valeur de ce champ, le Now Platform réinitialise le nombre de demandes à 0 et supprime toutes les violations pour l’heure en cours.
      Appliquer à Utilisateurs restreints par cette règle :
      • Un utilisateur unique applique la limite de taux à un utilisateur spécifique.
      • Utilisateurs avec rôle applique la limite de taux à tous les utilisateurs ayant un rôle spécifique.
      • Tous les utilisateurs applique la limite de taux à tous les utilisateurs.
      Rôle Rôle auquel la limite de taux s’applique. S’affiche uniquement lorsque vous sélectionnez Utilisateurs avec un rôle dans le champ Appliquer à .
      Utilisateur Utilisateur auquel la limite de taux s’applique. S’affiche uniquement lorsque vous sélectionnez Utilisateur unique dans le champ Appliquer à .
    3. Cliquez sur Envoyer.
      La nouvelle limite de taux entre en vigueur.

    Que faire ensuite

    Une fois que vous avez soumis la règle, ajoutez Now Platform les listes connexes suivantes à l’enregistrement de règle :
    Nombres de limites de taux
    Répertorie, par utilisateur, le nombre de demandes REST API entrantes affectées par cette règle de limite de taux.
    Violations des limites de taux
    Répertorie, par utilisateur, les violations de cette règle de limite de taux.

    Vous pouvez utiliser ces listes connexes pour .Surveiller le nombre de limites de taux et les violations des limites de taux de l’API REST entrantes