コンテンツにスキップ

JSONオブジェクト

ルールセットオブジェクト

完全に構成されたルールセットオブジェクトは、以下のJSON構造を持っています。

{
"id": "6a359df138c442b385d20140d4d96919",
"name": "例のルールセット",
"description": "例のルールセットの説明",
"kind": "custom",
"version": "2",
"phase": "http_request_firewall_custom",
"rules": [
{
"id": "fdb0dd271f3f40b19679cc5d91396024",
"version": "2",
"action": "block",
"expression": "cf.zone.name eq \"example.com\" ",
"last_updated": "2022-07-20T10:44:29.124515Z"
}
],
"last_updated": "2022-07-20T10:44:29.124515Z"
}

プロパティ

ルールセットオブジェクトには、以下のプロパティがあります:

  • id - 32文字のUUIDv4文字列:

    • 特定のバージョンのルールセットに対するCloudflare生成の一意の識別子を表します。
    • 一意で、読み取り専用です。
  • name - 文字列

    • ルールセットの人間が読みやすい名前です。
    • 名前は不変です。ルールセットの生涯にわたって名前を変更することはできません。
  • description - 文字列

    • ルールセットのオプションの説明です。
    • ルールセットの生涯にわたって説明を変更できます。
  • kind - rootzonemanagedcustomのいずれか

    • JSONオブジェクトが表すルールセットの種類です。
    • kindは不変です。
  • version - 1から始まり、ルールセットが変更されるたびに1ずつ増加する整数値

    • ルールセットのバージョンです。
    • 読み取り専用です。
  • rules - JSONオブジェクトの配列

    • ルールセットに含めるルールのリストです。
  • last_updated ISO 8601タイムスタンプ形式 YYYY-MM-DDThh:mm:ss.TZD

    • ルールセットが最後に更新された時間(UTC)です。
    • 読み取り専用です。

ルールオブジェクトの構造とプロパティ

完全に構成されたルールJSONオブジェクトは、以下の構造を持っています:

{
"id": "fdb0dd271f3f40b19679cc5d91396024",
"version": "2",
"action": "block",
"categories": ["wordpress"],
"expression": "cf.zone.name eq \"example.com\"",
"last_updated": "2022-07-20T10:44:29.124515Z",
"enabled": true
}

ルールのJSONオブジェクトプロパティは以下のように定義されています:

プロパティ説明ノート
id特定のバージョンのルールに対するCloudflare生成の一意の識別子を表します。32文字のUUIDv4文字列一意で、読み取り専用
versionルールのバージョンです。

1から始まり、ルールセットが変更されるたびに1ずつ増加する整数値

読み取り専用。ルールセット内のルールの順序を変更しても、そのバージョンは変更されません。
actionルールの式に一致した場合に何が起こるかを定義します。文字列利用可能なアクションは、ルールのルールセットが実行されるフェーズによって異なります。
categories

現在のルールに関連付けられたタグです。特定のタグを持つルールに影響を与えるオーバーライドを定義できます。

文字列の配列読み取り専用。WAF管理ルールでのみ利用可能です。
expression現在のルールに一致する条件を定義します。文字列

ルールのルールセットが実行されるフェーズによって、ルール式で使用できるフィールドと関数が異なります。

last_updatedルールが最後に更新された時間(UTC)です。ISO 8601タイムスタンプ形式 YYYY-MM-DDThh:mm:ss .TZD読み取り専用
enabled

trueに設定されている場合、現在のルールは有効です。

ブール値