GraphQL で Cloudflare WAN の IPsec/GRE トンネル帯域幅分析をクエリする

この例では、GraphQL Analytics API を使い、指定した期間の Cloudflare WAN の入力（ingress）トンネルトラフィックをクエリします。

次の API 呼び出しは、1 時間の Cloudflare WAN 入力トンネルトラフィックを要求し、指定したフィールドを出力します。<CLOUDFLARE_ACCOUNT_TAG> をアカウント ID に、<EMAIL>、<API_KEY>¹（レガシー）、または <API_TOKEN>²（推奨）を API 資格情報に置き換え、必要に応じて datetime_geq と datetime_leq の値を調整してください。

この例は入力トラフィックをクエリします。出力（egress）トラフィックをクエリするには、direction フィルターの値を変更します。

API 呼び出し

PAYLOAD='{ "query":
  "query GetTunnelHealthCheckResults($accountTag: string, $datetimeStart: string, $datetimeEnd: string) {
      viewer {
        accounts(filter: {accountTag: $accountTag}) {
          magicTransitTunnelTrafficAdaptiveGroups(
            limit: 100,
            filter: {
              datetime_geq: $datetimeStart,
              datetime_lt:  $datetimeEnd,
              direction: $direction
            }
          ) {
            avg {
              bitRateFiveMinutes
            }
            dimensions {
              tunnelName
              datetimeFiveMinutes
            }
          }
        }
      }
  }",
    "variables": {
      "accountTag": "<CLOUDFLARE_ACCOUNT_TAG>",
      "direction": "ingress",
      "datetimeStart": "2022-05-04T11:00:00.000Z",
      "datetimeEnd": "2022-05-04T12:00:00.000Z"
    }
  }
}'

# curl with Legacy API Key
curl https://api.cloudflare.com/client/v4/graphql \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "$(echo $PAYLOAD)"

# curl with API Token
curl https://api.cloudflare.com/client/v4/graphql \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "$(echo $PAYLOAD)"

戻り値は、特定のトンネルについて 5 分間隔の合計帯域幅（ビット毎秒）です。5 分以外の集計を使う場合は、メトリクスと日時の両方に同じ時間窓を使います。たとえば時間単位で分析するには、bitRateHour と datetimeHour を使います。

結果は（指定どおり）JSON なので、出力を jq に渡すと次の例のように読みやすくなります。

curl https://api.cloudflare.com/client/v4/graphql \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "$(echo $PAYLOAD)" | jq .

## Example response:
#=> {
#=>   "data": {
#=>     "viewer": {
#=>       "accounts": [
#=>         {
#=>           "magicTransitTunnelTrafficAdaptiveGroups": [
#=>             {
#=>               avg: { bitRateFiveMinutes:  327680 },
#=>               dimensions: {
#=>                 datetimeFiveMinute: '2021-05-12T22:00-00:00',
#=>                 tunnelName: 'tunnel_name'
#=>               }
#=>             },
#=>             {
#=>               avg: { bitRateFiveMinutes:  627213680 },
#=>               dimensions: {
#=>                 datetimeFiveMinute: '2021-05-12T22:05-00:00',
#=>                 tunnelName: 'another_tunnel'
#=>              }
#=>             }
#=>           ]
#=>         }
#=>       ]
#=>     }
#=>   },
#=>   "errors": null
#=> }

詳細は Cloudflare API キーで認証するを参照してください。 ↩
詳細は Analytics API トークンを設定するを参照してください。 ↩

GraphQL で Cloudflare WAN の IPsec/GRE トンネル帯域幅分析をクエリする

API 呼び出し

Footnotes