Options de commande

DNS_DOMAIN_ID

L'identifiant du domaine DNS. Obligatoire.

--json

Fichier JSON ou chaîne JSON utilisé(e) pour décrire une règle de limitation de débit.

• Les champs obligatoires dans les données JSON sont les suivants : match, threshold, period et action:
  • match: Détermine quel trafic est pris en compte par la règle de limitation de débit dans le calcul du seuil.
    • request: Correspond aux requêtes de type « HTTP ».
      • methods: HTTP Les méthodes peuvent être un sous-ensemble de [POST,PUT] ou l'ensemble complet de [_ALL_]. Cette zone n'est pas obligatoire pour créer une règle de limitation de débit. Les valeurs valides sont GET, POST, PUT, DELETE, PATCH, HEAD, _ALL_.
      • schemes: HTTP Les combinaisons possibles sont : soit [HTTPS], soit [HTTP, soit HTTPS], soit [_ALL_]. Cette zone n'est pas obligatoire.
      • url: Le modèle de correspondance « URL », composé de l'hôte et du chemin d'accès, par exemple example.org/path. Les caractères génériques s'appliquent au trafic mais non aux chaînes de requête. Utilisez * pour l'ensemble du trafic vers votre zone. La longueur maximale est de 1024.
    • response: Permet de filtrer les réponses de type « HTTP » avant qu’elles ne soient renvoyées au client. Avec cette option, tout le comptage du trafic a lieu à ce stade.
      • status: HTTP Codes d'état : il peut s'agir d'un seul code [403], de plusieurs codes [401,403] ou de tous les codes (en ne précisant pas cette valeur). Cette zone n'est pas obligatoire. La valeur minimale est 100 et la valeur maximale est 999.
      • headers: Tableau des en-têtes de réponse à comparer. Si une réponse ne répond pas aux critères d'en-tête, la requête n'est pas prise en compte dans le calcul de la règle de limitation de débit. Les critères de correspondance des en-têtes comprennent les propriétés suivantes.
        • name: Nom de l'en-tête de réponse à rechercher.
        • op: Opérateur utilisé lors de la comparaison : « eq » signifie « égal à » et « ne » signifie « différent de ». Les valeurs valides sont eq et ne.
        • value: La valeur de l'en-tête, qui correspond exactement.
  • threshold: Le seuil à partir duquel les mesures de limitation du débit sont déclenchées, associées à une durée. Par exemple, le seuil par période. La valeur minimale est 2 et la valeur maximale est 1000000.
  • period: Le temps, en secondes, nécessaire pour compter le trafic correspondant. Si le nombre dépasse le seuil au cours de cette période, l'action est exécutée. La valeur minimale est 10 et la valeur maximale est 86400.
  • action: Action déclenchée lorsque le seuil de trafic correspondant est dépassé au cours de la période définie.
    • mode: Le type d'action effectuée. Les valeurs valides sont : simulate, ban, challenge, js_challenge.
    • timeout: Le délai, en secondes (sous forme de nombre entier), nécessaire pour mettre en œuvre la mesure d'atténuation. Le délai d'expiration peut être identique ou supérieur à la durée. Ce champ n'est valide que lorsque le mode est « simulate » ou « ban ». La valeur minimale est 10 et la valeur maximale est 86400.
    • response: Type de contenu et corps personnalisés à renvoyer. Remplace l'erreur personnalisée de la zone. Cette zone n'est pas obligatoire. Si elle est omise, la page d'erreur HTML par défaut est générée. Cette zone n'est valide que si le mode est simulate ou ban.
      • content_type: Le type de contenu du corps du message, qui doit être l'un des suivants : text/plain, text/xml, application/json.
      • body: Le corps doit revenir. Le contenu ici doit être conforme au type content_type. La longueur maximale est de 10240.
• Les zones facultatives sont id, disabled, description, correlate et bypass :
  • id: Identifiant de la règle limitant le débit.
  • disabled: Indique si cette règle de limitation de débit est actuellement désactivée.
  • description: Une note que vous pouvez utiliser pour expliquer la raison d'une règle de limitation de débit.
  • correlate: Activer ou non la limitation de débit basée sur le NAT.
    • by: La valeur valide est « nat ».
  • bypass: Critères permettant de contourner la limite de débit. Par exemple, pour indiquer qu'il ne faut pas appliquer de limite de débit à un ensemble d'URL.
    • name: La valeur valide est « url ».
    • value: L'URL à contourner.

Exemple de données JSON :

{
   "id": "92f17202ed8bd63d69a66b86a49a8f6b",
   "disabled": false,
   "description": "Prevent multiple login failures to mitigate brute force attacks",
   "bypass": [
      {
         "name": "url",
         "value": "api.example.com/*"
      }
   ],
   "threshold": 60,
   "period": 900,
   "correlate": {
      "by": "nat"
   },
   "action": [
      {
         "mode": "simulate",
         "timeout": 86400,
         "response": {
            "content_type": "text/plain",
            "body": "<error>This request has been rate-limited.</error>"
         }
      }
   ],
   "match": {
      "request": {
               "methods": [
                  "GET"
               ],
               "schemes": [
                  "HTTP",
                  "HTTPS"
               ],
               "url": "*.example.org/path*"
      },
      "response": {
         "status": [
               403, 401
         ],
         "headers": [
            {
               "name": "Cf-Cache-Status",
               "op": "eq",
               "value": "HIT"
            }
         ]
      }
   }
}

-i, --instance

Nom ou ID de l'instance. Si le nom ou l'ID de l'instance n'est pas défini, c'est l'instance de contexte spécifiée par ibmcloud cis instance-set INSTANCE qui est utilisée.

--output

Format de sortie. À l'heure actuelle, « json » est la seule valeur prise en charge.

Options de commande

DNS_DOMAIN_ID

L'identifiant du domaine DNS. Obligatoire.

RATELIMIT_RULE_ID

L'identifiant de la règle de limitation de débit. Obligatoire.

--json

Le fichier JSON ou la chaîne JSON utilisée pour décrire une règle de limitation de débit.

• Les champs obligatoires dans les données JSON sont les suivants : match, threshold, period et action:
  • match: Détermine quel trafic est pris en compte par la règle de limitation de débit dans le calcul du seuil.
    • request: Correspond aux requêtes de type « HTTP ».
      • methods: HTTP Les méthodes peuvent être un sous-ensemble de [POST,PUT] ou l'ensemble complet de [ALL]. Cette zone n'est pas obligatoire pour créer une règle de limitation de débit. Les valeurs valides sont GET, POST, PUT, DELETE, PATCH, HEAD, ALL.
      • schemes: HTTP Les combinaisons possibles sont : un seul [HTTPS], les deux [HTTP,HTTPS] ou les trois [_ALL_]. Cette zone n'est pas obligatoire.
      • url: Le modèle « URL » à faire correspondre comprenait le nom d'hôte et le chemin d'accès, par exemple : example.org/path. Les caractères génériques s'appliquent au trafic mais non aux chaînes de requête. Utilisez * pour l'ensemble du trafic vers votre zone. La longueur maximale est de 1024.
    • response: Permet de filtrer les réponses de type « HTTP » avant qu’elles ne soient renvoyées au client. Si ce champ est défini, le comptage complet du trafic s'effectue à cette étape.
      • status: HTTP Codes d'état : il peut s'agir d'un seul code [403], de plusieurs codes [401,403] ou de tous les codes (en ne précisant pas cette valeur). Cette zone n'est pas obligatoire. La valeur minimale est 100 et la valeur maximale est 999.
      • headers: Tableau des en-têtes de réponse à comparer. Si une réponse ne répond pas aux critères d'en-tête, la requête n'est pas prise en compte dans le calcul de la règle de limitation de débit. L'ensemble des critères de correspondance des en-têtes comprend les propriétés suivantes.
        • name: Nom de l'en-tête de réponse à rechercher.
        • op: Opérateur utilisé lors de la comparaison : « eq » signifie « égal à » et « ne » signifie « différent de ». Les valeurs valides sont eq et ne.
        • value: La valeur de l'en-tête, qui correspond exactement.
  • threshold: Le seuil à partir duquel les mesures de limitation du débit sont déclenchées; celles-ci sont associées à la période. Par exemple, le seuil par période. La valeur minimale est 2 et la valeur maximale est 1000000.
  • period: Le temps, en secondes, nécessaire pour compter le trafic correspondant. Si le nombre dépasse le seuil au cours de cette période, l'action est exécutée. La valeur minimale est 1 et la valeur maximale est 3600.
  • action: L'action est déclenchée lorsque le seuil de trafic correspondant est dépassé au cours de la période définie.
    • mode: Le type d'action effectuée. Les valeurs valides sont : simulate, ban, challenge, js_challenge.
    • timeout: Le temps, en secondes, exprimé sous forme de nombre entier, nécessaire pour mettre en œuvre la mesure d'atténuation. Le délai d'expiration est égal ou supérieur à la durée. Cette zone n'est valide que si le mode est simulate ou ban. La valeur minimale est 10 et la valeur maximale est 86400.
    • response: Type de contenu et corps personnalisés à renvoyer. Remplace l'erreur personnalisée de la zone. Cette zone n'est pas obligatoire. Si elle est omise, la page d'erreur HTML par défaut est générée. Cette zone n'est valide que si le mode est simulate ou ban.
      • content_type: Le type de contenu du corps du message, qui doit être l'un des suivants : text/plain, text/xml, application/json.
      • body: Le corps doit revenir. Le contenu ici doit être conforme au type content_type. La longueur maximale est de 10240.
• Les zones facultatives sont disabled, description, correlate et bypass:
  • disabled: Indique si cette règle de limitation de débit est actuellement désactivée.
  • description: Une note que vous pouvez utiliser pour expliquer la raison d'une règle de limitation de débit.
  • correlate: Activer ou non la limitation de débit basée sur le NAT.
    • by: La valeur valide est « nat ».
  • bypass: Critères permettant de contourner la limite de débit. Par exemple, pour indiquer qu'il ne faut pas appliquer de limite de débit à un ensemble d'URL.
    • name: La valeur valide est « url ».
    • value: L'URL à contourner.

Exemple de données JSON :

{
   "disabled": false,
   "description": "Prevent multiple login failures to mitigate brute force attacks",
   "bypass": [
      {
         "name": "url",
         "value": "api.example.com/*"
      }
   ],
   "threshold": 60,
   "period": 900,
   "correlate": {
      "by": "nat"
   },
   "action": [
      {
         "mode": "simulate",
         "timeout": 86400,
         "response": {
            "content_type": "text/plain",
            "body": "<error>This request has been rate-limited.</error>"
         }
      }
   ],
   "match": {
      "request": {
               "methods": [
                  "GET"
               ],
               "schemes": [
                  "HTTP",
                  "HTTPS"
               ],
               "url": "*.example.org/path*"
      },
      "response": {
         "status": [
               403, 401
         ],
         "headers": [
            {
               "name": "Cf-Cache-Status",
               "op": "eq",
               "value": "HIT"
            }
         ]
      }
   }
}

-i, --instance

Nom ou ID de l'instance. Si cette option n'est pas définie, l'instance de contexte spécifiée par ibmcloud cis instance-set INSTANCE est utilisée.

--output

Précisez le format de sortie; seul le format « JSON » est pris en charge.

Options de commande

DNS_DOMAIN_ID

L'identifiant du domaine DNS. Obligatoire.

RATELIMIT_RULE_ID

L'identifiant de la règle de limitation de débit. Obligatoire.

-i, --instance

Nom ou ID de l'instance. Si cette option n'est pas définie, l'instance de contexte spécifiée par ibmcloud cis instance-set INSTANCE est utilisée.

Pour plus d'informations, consultez la section « Limitation du débit via l'interface CLI ».