Befehlsoptionen

DNS_DOMAIN_ID

Die ID der DNS-Domäne. Erforderlich.

--json

Die JSON-Datei oder der JSON-String, der zur Beschreibung einer Regel zur Ratenbegrenzung verwendet wird.

• Die Pflichtfelder in den JSON-Daten sind „ match “, „ threshold “, „ period “ und „ action “:
  • match: Legt fest, welcher Datenverkehr bei der Berechnung des Schwellenwerts durch die Regel zur Ratenbegrenzung berücksichtigt wird.
    • request: Entspricht den Suchanfragen „ HTTP “.
      • methods: HTTP Methoden, die entweder eine Teilmenge von [POST,PUT] oder alle von [_ALL_] sein können. Dieses Feld ist nicht zum Erstellen einer Drosselungsregel erforderlich. Gültige Werte sind GET, POST, PUT, DELETE, PATCH, HEAD, _ALL_.
      • schemes: HTTP Schemes, kann eines sein [HTTPS], beide [HTTP,HTTPS] oder alle [_ALL_]. Dieses Feld ist nicht erforderlich.
      • url: Das Muster „ URL “, das aus dem Host und dem Pfad besteht, zum Beispiel example.org/path. Platzhalterzeichen werden auf den zutreffenden Datenverkehr erweitert, Abfragezeichenfolgen werden nicht abgeglichen. Verwenden Sie * für den gesamten Datenverkehr in Ihrer Zone. Die maximale Länge beträgt 1024.
    • response: Passt auf „ HTTP “-Antworten, bevor diese an den Client zurückgesendet werden. Wenn diese Option definiert ist, dann erfolgt die gesamte Zählung des Verkehrs in dieser Phase.
      • status: HTTP Statuscodes; es kann sich um einen einzelnen Wert handeln ( [403]), um mehrere Werte ( [401,403] ) oder um alle Werte, wenn dieser Wert nicht angegeben wird. Dieses Feld ist nicht erforderlich. Der Minimalwert lautet 100 und der Maximalwert 999.
      • headers: Array der zu suchenden Antwort-Header. Wenn eine Antwort die Header-Kriterien nicht erfüllt, wird die Anfrage nicht auf die Rate-Limiting-Regel angerechnet. Die Kriterien für den Abgleich der Kopfzeilen umfassen die folgenden Eigenschaften.
        • name: Der Name des Antwort-Headers, der abgeglichen werden soll.
        • op: Der Operator beim Abgleich; „eq“ bedeutet „gleich“, „ne“ bedeutet „ungleich“. Gültige Werte sind eq und ne.
        • value: Der Wert des Headers, der exakt übereinstimmt.
  • threshold: Der Schwellenwert, ab dem die Maßnahmen zur Begrenzung der Zugriffsrate ausgelöst werden; dieser ist mit einem Zeitraum verknüpft. Zum Beispiel der Schwellenwert pro Zeitraum. Der Minimalwert lautet 2 und der Maximalwert 1000000.
  • period: Die Zeit in Sekunden, die benötigt wird, um den übereinstimmenden Datenverkehr zu zählen. Wenn der Wert innerhalb dieses Zeitraums den Schwellenwert überschreitet, wird die Aktion ausgeführt. Der Minimalwert lautet 10 und der Maximalwert 86400.
  • action: Die Aktion, die ausgeführt wird, wenn der Schwellenwert für den übereinstimmenden Datenverkehr innerhalb des festgelegten Zeitraums überschritten wird.
    • mode: Die Art der durchgeführten Aktion. Gültige Werte sind: simulate, ban, challenge, js_challenge.
    • timeout: Die Zeit in Sekunden (als Ganzzahl), innerhalb derer die Abhilfemaßnahme durchgeführt werden soll. Die Auszeit kann genauso lang oder länger als die Spielzeit sein. Dieses Feld ist nur gültig, wenn der Modus „ simulate “ oder „ ban “ ist. Der Minimalwert lautet 10 und der Maximalwert 86400.
    • response: Benutzerdefinierter Inhaltstyp und Textkörper, die zurückgegeben werden sollen. Dadurch wird der angepasste Fehler für die Zone überschrieben. Dieses Feld ist nicht erforderlich. Wird dieses Feld nicht angegeben, ist das Ergebnis die HTML-Standardfehlerseite. Dieses Feld ist nur gültig, wenn für 'mode' der Wert simulate oder ban angegeben ist.
      • content_type: Der Content-Type des Hauptteils, der einer der folgenden sein muss: text/plain, text/xml, application/json.
      • body: Der Körper soll zurückgebracht werden. Der Inhalt muss dem Inhaltstyp (content_type) entsprechen. Die maximale Länge beträgt 10240.
• Die optionalen Felder sind id, disabled, description, correlate und bypass:
  • id: Kennung der geschwindigkeitsbegrenzenden Regel.
  • disabled: Ob diese Regel zur Ratenbegrenzung derzeit deaktiviert ist.
  • description: Eine Anmerkung, mit der Sie den Grund für eine Regel zur Ratenbegrenzung beschreiben können.
  • correlate: Ob die NAT-basierte Ratenbegrenzung aktiviert werden soll.
    • by: Ein gültiger Wert ist „ nat “.
  • bypass: Kriterien, unter denen die Ratenbegrenzung umgangen werden kann. Um beispielsweise anzugeben, dass für eine Reihe von URLs kein Ratenlimit gelten soll.
    • name: Ein gültiger Wert ist „ url “.
    • value: Die URL, die umgangen werden soll.

JSON-Beispieldaten:

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

Instanzname oder ID. Wenn kein Instanzname oder keine Instanz-ID festgelegt ist, wird die Kontextinstanz verwendet, die durch „ ibmcloud cis instance-set INSTANCE “ angegeben wird.

--output

Das Ausgabeformat. Derzeit ist „ json “ der einzige unterstützte Wert.

Befehlsoptionen

DNS_DOMAIN_ID

Die ID der DNS-Domäne. Erforderlich.

RATELIMIT_RULE_ID

Die ID der Regel zur Begrenzung der Übertragungsrate. Erforderlich.

--json

Die JSON-Datei oder der JSON-String, der zur Beschreibung einer Regel zur Ratenbegrenzung verwendet wird.

• Die Pflichtfelder in den JSON-Daten sind „ match “, „ threshold “, „ period “ und „ action “:
  • match: Legt fest, welcher Datenverkehr bei der Berechnung des Schwellenwerts durch die Regel zur Ratenbegrenzung berücksichtigt wird.
    • request: Entspricht den Suchanfragen „ HTTP “.
      • methods: HTTP Methoden, die entweder eine Teilmenge von [POST,PUT] oder alle von [ALL] sein können. Dieses Feld ist nicht zum Erstellen einer Drosselungsregel erforderlich. Gültige Werte sind GET, POST, PUT, DELETE, PATCH, HEAD, ALL.
      • schemes: HTTP Schemes, kann eines sein [HTTPS], beide [HTTP,HTTPS] oder alle [_ALL_]. Dieses Feld ist nicht erforderlich.
      • url: Das zu vergleichende Muster „ URL “ bestand aus dem Host und dem Pfad, zum Beispiel example.org/path. Platzhalterzeichen werden auf den zutreffenden Datenverkehr erweitert, Abfragezeichenfolgen werden nicht abgeglichen. Verwenden Sie * für den gesamten Datenverkehr in Ihrer Zone. Die maximale Länge beträgt 1024.
    • response: Passt auf „ HTTP “-Antworten, bevor diese an den Client zurückgesendet werden. Wenn dieses Feld definiert ist, erfolgt die gesamte Verkehrszählung in dieser Phase.
      • status: HTTP Statuscodes; es kann sich um einen einzelnen Wert handeln ( [403]), um mehrere Werte ( [401,403] ) oder um alle Werte, wenn dieser Wert nicht angegeben wird. Dieses Feld ist nicht erforderlich. Der Minimalwert lautet 100 und der Maximalwert 999.
      • headers: Array der zu suchenden Antwort-Header. Wenn eine Antwort die Header-Kriterien nicht erfüllt, wird die Anfrage nicht auf die Rate-Limiting-Regel angerechnet. Zu den verschiedenen Kriterien für den Abgleich von Kopfzeilen gehören die folgenden Eigenschaften.
        • name: Der Name des Antwort-Headers, der abgeglichen werden soll.
        • op: Der Operator beim Abgleich; „eq“ bedeutet „gleich“, „ne“ bedeutet „ungleich“. Gültige Werte sind eq und ne.
        • value: Der Wert des Headers, der exakt übereinstimmt.
  • threshold: Der Schwellenwert, ab dem die Maßnahmen zur Begrenzung der Zugriffsrate ausgelöst werden; dieser wird mit dem Zeitraum kombiniert. Zum Beispiel der Schwellenwert pro Zeitraum. Der Minimalwert lautet 2 und der Maximalwert 1000000.
  • period: Die Zeit in Sekunden, die benötigt wird, um den übereinstimmenden Datenverkehr zu zählen. Wenn der Zählwert innerhalb dieses Zeitraums den Schwellenwert überschreitet, wird die Aktion ausgeführt. Der Minimalwert lautet 1 und der Maximalwert 3600.
  • action: Die Aktion wird ausgeführt, wenn der Schwellenwert für den übereinstimmenden Datenverkehr innerhalb des festgelegten Zeitraums überschritten wird.
    • mode: Die Art der durchgeführten Aktion. Gültige Werte sind simulate, ban, challenge und js_challenge.
    • timeout: Die Zeit in Sekunden (als Ganzzahl) für die Durchführung der Abhilfemaßnahme. Die Auszeit ist genauso lang oder länger als die Spielzeit. Dieses Feld ist nur gültig, wenn für 'mode' der Wert simulate oder ban angegeben ist. Der Minimalwert lautet 10 und der Maximalwert 86400.
    • response: Benutzerdefinierter Inhaltstyp und Textkörper, die zurückgegeben werden sollen. Dadurch wird der angepasste Fehler für die Zone überschrieben. Dieses Feld ist nicht erforderlich. Wird dieses Feld nicht angegeben, ist das Ergebnis die HTML-Standardfehlerseite. Dieses Feld ist nur gültig, wenn für 'mode' der Wert simulate oder ban angegeben ist.
      • content_type: Der Content-Type des Hauptteils, der einer der folgenden sein muss: text/plain, text/xml, application/json.
      • body: Der Körper soll zurückgebracht werden. Der Inhalt muss dem Inhaltstyp (content_type) entsprechen. Die maximale Länge beträgt 10240.
• Die optionalen Felder sind disabled, description, correlate und bypass:
  • disabled: Ob diese Regel zur Ratenbegrenzung derzeit deaktiviert ist.
  • description: Eine Anmerkung, mit der Sie den Grund für eine Regel zur Ratenbegrenzung beschreiben können.
  • correlate: Ob die NAT-basierte Ratenbegrenzung aktiviert werden soll.
    • by: Ein gültiger Wert ist „ nat “.
  • bypass: Kriterien, unter denen die Ratenbegrenzung umgangen werden kann. Um beispielsweise anzugeben, dass für eine Reihe von URLs kein Ratenlimit gelten soll.
    • name: Ein gültiger Wert ist „ url “.
    • value: Die URL, die umgangen werden soll.

JSON-Beispieldaten:

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

Instanzname oder ID. Wenn dieser Wert nicht festgelegt ist, wird die durch „ ibmcloud cis instance-set INSTANCE “ angegebene Kontextinstanz verwendet.

--output

Geben Sie das Ausgabeformat an; es wird ausschließlich „ JSON “ unterstützt.

Befehlsoptionen

DNS_DOMAIN_ID

Die ID der DNS-Domäne. Erforderlich.

RATELIMIT_RULE_ID

Die ID der Rate-Limit-Regel. Erforderlich.

-i, --instance

Instanzname oder ID. Wenn dieser Wert nicht festgelegt ist, wird die durch „ ibmcloud cis instance-set INSTANCE “ angegebene Kontextinstanz verwendet.

Weitere Informationen finden Sie unter „ CLI-Ratenbegrenzung “.