Settings ノード

Cloudflare GraphQL API は、70 を超えるデータセットを公開しています。これらのデータセットは、データ形状が大きく異なるさまざまな Cloudflare 製品を表すため、それぞれに制限の設定があります。

必須データセット（httpRequestsAdaptiveGroups、firewallEventsAdaptive など）はすべてのプランで利用できますが、上位プランのユーザーは、追加のデータセットとより広いクエリ制限を利用できます。

イントロスペクションに加えて、zones スコープと accounts スコープの両方で使える Settings ノードがあります。

形式

Settings ノードは、zones と accounts のすべてのデータセットをフィールドとして持ちます。

accounts ノードで settings ノードを使うgraphql

{
  viewer {
    accounts(filter: { accountTag : $accountTag }) {
      settings {
        # any dataset(s) from accounts
      }
    }
    zones(filter: { zoneTag : $zoneTag }) {
      settings {
        # any dataset(s) from zones
      }
    }
  }
}

settings ノードの各サブノードは、次のフィールドで構成されます。

enabled - リクエストしたユーザーがそのノードを使えるかどうか
availableFields - リクエストしたユーザーが使えるフィールドの一覧。入れ子のフィールドの場合は、sum_requests のようなパスが返されます
maxPageSize - 返せるレコード数の上限
maxNumberOfFields - そのノードの 1 クエリで使えるフィールド数
notOlderThan - クエリが遡って読み取れる秒数
maxDuration - リクエストできる時間範囲の幅

クエリの例

firewallEventsAdaptive ノードの境界を取得するgraphql

query SampleQuery($zoneTag: string) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			settings {
				firewallEventsAdaptive {
					enabled
					maxDuration
					maxNumberOfFields
					maxPageSize
					notOlderThan
				}
			}
		}
	}
}

特定ユーザーの firewallEventsAdaptive 制限json

{
	"data": {
		"viewer": {
			"zones": [
				{
					"settings": {
						"firewallEventsAdaptive": {
							"enabled": true,
							"maxDuration": 259200,
							"maxNumberOfFields": 30,
							"maxPageSize": 10000,
							"notOlderThan": 2678400
						}
					}
				}
			]
		}
	},
	"errors": null
}

クエリの実行方法の詳細は、はじめにのガイドを参照してください。