コンテンツにスキップ

設定ノード

Cloudflare GraphQL APIは、顧客に70以上のデータセットを公開しています。これらのデータセットは、非常に異なるデータ形状を持つさまざまなCloudflare製品を表しており、それぞれに制限の設定があります。

基本的なデータセット(httpRequestsAdaptiveGroupsfirewallEventsAdaptiveなど)へのアクセスはすべてのプランで許可されていますが、大規模なプランのユーザーは、拡張されたデータセットと広範なクエリ制限の恩恵を受けます。

イントロスペクションに加えて、ユーザーはゾーンとアカウントのスコープの両方で利用可能な設定ノードを使用できます。

フォーマット

Settingsノードには、zonesおよびaccountsからのすべてのデータセットがフィールドとして含まれています。

アカウントノードでの設定ノードの使用
{
viewer {
accounts(filter: { accountTag : $accountTag }) {
settings {
# アカウントからの任意のデータセット
}
}
zones(filter: { zoneTag : $zoneTag }) {
settings {
# ゾーンからの任意のデータセット
}
}
}
}

settingsノードの各サブノードは、以下のフィールドで構成される可能性があります:

  • enabled - ノードがリクエスターに対して利用可能かどうかを示します;
  • availableFields - リクエスターに対して利用可能なフィールドのリストを示します。ネストされたフィールドの場合、パスが返されます(例:sum_requests);
  • maxPageSize - 返される最大レコード数を取得します;
  • maxNumberOfFields - そのノードの単一クエリで使用できるフィールドの数を示します;
  • notOlderThan - クエリがどれだけ過去のデータを読み取れるかを示す秒数を返します;
  • maxDuration - リクエストされた時間範囲の広さを示します。

サンプルクエリ

firewallEventsAdaptiveノードの境界を取得
{
viewer {
zones(filter: { zoneTag: $zoneTag }) {
settings {
firewallEventsAdaptive {
enabled
maxDuration
maxNumberOfFields
maxPageSize
notOlderThan
}
}
}
}
}
特定のユーザーのfirewallEventsAdaptive制限
{
"data": {
"viewer": {
"zones": [
{
"settings": {
"firewallEventsAdaptive": {
"enabled": true,
"maxDuration": 259200,
"maxNumberOfFields": 30,
"maxPageSize": 10000,
"notOlderThan": 2678400
}
}
}
]
}
},
"errors": null
}

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