コマンド・オプション

DNS_DOMAIN_ID

DNSドメインのID。 必須。

--json

レート制限ルールを記述するために使用されるJSONファイルまたはJSON文字列。

• JSON データで必須となるフィールドは、 match、 threshold、 period 、および action です：
  • match: レート制限ルールが、どのトラフィックを閾値の算定対象とするかを決定します。
    • request: 「 HTTP 」というリクエストに一致します。
      • methods: HTTP メソッドは、 [POST,PUT] のサブセットである場合もあれば、 [_ALL_] のすべてである場合もあります。 レート制限ルールを作成する際、このフィールドは必須ではありません。 有効な値は、GET、POST、PUT、DELETE、PATCH、HEAD、_ALL_ です。
      • schemes: HTTP スキームは、 [HTTPS] のいずれか、 [HTTP と HTTPS] の両方、あるいは [_ALL_] のすべてである可能性があります。 このフィールドは必須ではありません。
      • url: ホストとパスで構成されるリソースに一致する「 URL 」パターン。例： example.org/path。 ワイルドカードは適用可能なトラフィックを一致させるために拡張されます。照会ストリングは一致されません。 ゾーンへのすべてのトラフィックには * を使用します。 最大長は 1024 です。
    • response: クライアントに返される前に、 HTTP のレスポンスに一致するものを抽出します。 これが定義されると、トラフィックの全体の合計がこのステージで発生します。
      • status: HTTP ステータスコード。1つ指定する場合は [403]、複数指定する場合は [401,403] 、またはこの値を指定しない場合はすべてを意味します。 このフィールドは必須ではありません。 最小値は 100、最大値は 999 です。
      • headers: 照合対象のレスポンスヘッダーの配列。 レスポンスがヘッダーの基準を満たさない場合、そのリクエストはレート制限ルールの対象にはカウントされません。 ヘッダーの照合条件には、以下のプロパティが含まれます。
        • name: 照合対象のレスポンスヘッダー名。
        • op: マッチング時の演算子。「eq」は「等しい」を、「ne」は「等しくない」を意味します。 有効な値は eq および ne です。
        • value: ヘッダーの値。これが完全に一致します。
  • threshold: レート制限の緩和措置を発動させる閾値。これには期間が組み合わされています。 例えば、期間ごとの閾値などです。 最小値は 2、最大値は 1000000 です。
  • period: 一致するトラフィックをカウントするのにかかる時間（秒単位）。 この期間内にカウントが閾値を超えた場合、そのアクションが実行されます。 最小値は 10 、最大値は 86400 です。
  • action: 定義された期間内に、一致したトラフィックの閾値を超えた場合に実行されるアクション。
    • mode: 実行されたアクションの種類。 有効な値は、simulate、ban、challenge、js_challenge です。
    • timeout: 緩和措置を実行するための時間を秒単位で、整数として指定します。 タイムアウトは、その期間と同じか、それ以上とすることができます。 このフィールドは、モードが「 simulate 」または「 ban 」の場合にのみ有効です。 最小値は 10 、最大値は 86400 です。
    • response: 返すカスタムコンテンツタイプと本文。 これはゾーンのカスタム・エラーをオーバーライドします。 このフィールドは必須ではありません。 指定しないと、デフォルトの HTML エラー・ページが使用されます。 このフィールドはモードが simulate または ban のときのみ有効です。
      • content_type: 本文のコンテンツタイプ。以下のいずれかでなければなりません： text/plain、 text/xml、 application/json。
      • body: 戻ってくる体。 この内容は、content_type と一致する必要があります。 最大長は 10240 です。
• オプション・フィールドは、id、disabled、description、correlate、および bypass です。
  • id: 速度制限ルールの識別子。
  • disabled: このレート制限ルールが現在無効になっているかどうか。
  • description: レート制限ルールの理由を説明するために使用できるメモです。
  • correlate: NAT ベースのレート制限を有効にするかどうか。
    • by: 有効な値は「 nat 」です。
  • bypass: レート制限を無効にできる条件。 たとえば、特定のURL群にはレート制限を適用すべきではないことを示す場合などです。
    • name: 有効な値は「 url 」です。
    • value: バイパスするURL。

サンプル 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

インスタンスの名前または ID。 インスタンス名またはIDが設定されていない場合は、 ibmcloud cis instance-set INSTANCE で指定されたコンテキストインスタンスが使用されます。

--output

出力形式。 現在、 json が唯一サポートされている値です。

コマンド・オプション

DNS_DOMAIN_ID

DNSドメインのID。 必須。

RATELIMIT_RULE_ID

レート制限ルールのID。 必須。

--json

レート制限ルールを記述するために使用されるJSONファイルまたはJSON文字列。

• JSON データで必須となるフィールドは、 match、 threshold、 period 、および action です：
  • match: レート制限ルールが、どのトラフィックを閾値の算定対象とするかを決定します。
    • request: 「 HTTP 」というリクエストに一致します。
      • methods: HTTP メソッドは、 [POST,PUT] のサブセットである場合もあれば、 [ALL] のすべてである場合もあります。 レート制限ルールを作成する際、このフィールドは必須ではありません。 有効な値は、GET、POST、PUT、DELETE、PATCH、HEAD、ALL です。
      • schemes: HTTP スキームは、 [HTTPS] のいずれか、 [HTTP,HTTPS] の両方、または [_ALL_] のすべてである可能性があります。 このフィールドは必須ではありません。
      • url: 照合対象となる「 URL 」というパターンは、ホスト名とパスで構成されていました。例えば、 example.org/path といった形です。 ワイルドカードは適用可能なトラフィックを一致させるために拡張されます。照会ストリングは一致されません。 ゾーンへのすべてのトラフィックには * を使用します。 最大長は 1024 です。
    • response: クライアントに返される前に、 HTTP のレスポンスに一致するものを抽出します。 このフィールドが定義されている場合、トラフィックの集計はすべてこの段階で実行されます。
      • status: HTTP ステータスコード。1つ指定する場合は [403]、複数指定する場合は [401,403] 、またはこの値を指定しない場合はすべてを意味します。 このフィールドは必須ではありません。 最小値は 100 、最大値は 999 です。
      • headers: 照合対象のレスポンスヘッダーの配列。 レスポンスがヘッダーの基準を満たさない場合、そのリクエストはレート制限ルールの対象にはカウントされません。 ヘッダー照合基準には、以下のプロパティが含まれます。
        • name: 照合対象のレスポンスヘッダー名。
        • op: マッチング時の演算子。「eq」は「等しい」を、「ne」は「等しくない」を意味します。 有効な値は eq および ne です。
        • value: ヘッダーの値。これが完全に一致します。
  • threshold: レート制限の緩和措置を発動させる閾値。これは「期間」と組み合わせて使用されます。 例えば、期間ごとの閾値などです。 最小値は 2 、最大値は 1000000 です。
  • period: 一致するトラフィックをカウントするのにかかる時間（秒単位）。 この期間内にカウントが閾値を超えた場合、そのアクションが実行されます。 最小値は 1 、最大値は 3600 です。
  • action: 定義された期間内に、一致したトラフィックの閾値を超えた場合に、このアクションが実行されます。
    • mode: 実行されたアクションの種類。 有効な値は、 simulate、 ban、 challenge、 js_challenge です。
    • timeout: 緩和措置を実行するまでの時間（秒単位）。整数で指定してください。 タイムアウトは、その期間と同じかそれ以上です。 このフィールドはモードが simulate または ban のときのみ有効です。 最小値は 10 、最大値は 86400 です。
    • response: 返すカスタムコンテンツタイプと本文。 これはゾーンのカスタム・エラーをオーバーライドします。 このフィールドは必須ではありません。 指定しないと、デフォルトの HTML エラー・ページが使用されます。 このフィールドはモードが simulate または ban のときのみ有効です。
      • content_type: 本文のコンテンツタイプ。以下のいずれかでなければなりません： text/plain、 text/xml、 application/json。
      • body: 戻ってくる体。 この内容は、content_type と一致する必要があります。 最大長は 10240 です。
• オプション・フィールドは、disabled、description、correlate、および bypass です。
  • disabled: このレート制限ルールが現在無効になっているかどうか。
  • description: レート制限ルールの理由を説明するために使用できるメモです。
  • correlate: NAT ベースのレート制限を有効にするかどうか。
    • by: 有効な値は「 nat 」です。
  • bypass: レート制限を無効にできる条件。 たとえば、特定のURL群にはレート制限を適用すべきではないことを示す場合などです。
    • name: 有効な値は「 url 」です。
    • value: バイパスするURL。

サンプル 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

インスタンスの名前または ID。 設定されていない場合は、 ibmcloud cis instance-set INSTANCE で指定されたコンテキストインスタンスが使用されます。

--output

出力形式を指定してください。 JSON のみがサポートされています。

コマンド・オプション

DNS_DOMAIN_ID

DNSドメインのID。 必須。

RATELIMIT_RULE_ID

レート制限ルールのID。 必須。

-i, --instance

インスタンスの名前または ID。 設定されていない場合は、 ibmcloud cis instance-set INSTANCE で指定されたコンテキストインスタンスが使用されます。

詳細については、「 CLIのレート制限 」を参照してください。