GraphQL で Magic Transit のトンネルヘルスチェック結果を照会する

この例では、GraphQL Analytics API を使って Magic Transit のトンネルヘルスチェック結果を照会します。結果は、アカウントで設定したトンネルに対して Cloudflare サーバーが実行する個々のヘルスチェックから集計されます。過去 3 か月以内の日付について、最大 1 週間分のデータを照会できます。

次の API 呼び出しは、特定のアカウントについて、特定の Cloudflare データセンターにおける 1 日間のトンネルヘルスチェックを要求し、指定したフィールドを出力します。<CLOUDFLARE_ACCOUNT_TAG> と <API_TOKEN>¹ を API 認証情報に置き換え、必要に応じて datetimeStart と datetimeEnd を調整してください。

API 呼び出しは、Cloudflare データセンターごとのトンネルヘルスチェック結果を返します。各データセンターの結果は、個々のサーバーで実施したヘルスチェックから集計されます。tunnelState フィールドはトンネルの状態を表します。Magic Transit はこの状態をルーティングに使います。tunnelState の値 0 はダウンしたトンネル、0.5 は劣化したトンネル、1 は正常なトンネルを表します。

API 呼び出し

echo '{ "query":
  "query GetTunnelHealthCheckResults($accountTag: string, $datetimeStart: string, $datetimeEnd: string) {
    viewer {
      accounts(filter: {accountTag: $accountTag}) {
        magicTransitTunnelHealthChecksAdaptiveGroups(
          limit: 100,
          filter: {
            datetime_geq: $datetimeStart,
            datetime_lt:  $datetimeEnd,
          }
        ) {
          avg {
            tunnelState
          }
          dimensions {
            tunnelName
            edgeColoName
          }
        }
      }
    }
  }",
  "variables": {
    "accountTag": "<CLOUDFLARE_ACCOUNT_TAG>",
    "datetimeStart": "2022-08-04T00:00:00.000Z",
    "datetimeEnd": "2022-08-04T01:00:00.000Z"
  }
}' | tr -d '\n' | curl --silent \
https://api.cloudflare.com/client/v4/graphql \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data @-

結果は（要求どおり）JSON で返るため、出力を jq にパイプすると読みやすく整形できます。次の例を参照してください。

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

## Example response:
#=> {
#=>   "data": {
#=>     "viewer": {
#=>       "accounts": [
#=>         {
#=>           "conduitEdgeTunnelHealthChecks": [
#=>             {
#=>               {
#=>                 "avg": {
#=>                   "tunnelState": 1
#=>                 },
#=>                 "dimensions": {
#=>                   "edgeColoName": "mel01",
#=>                   "tunnelName": "tunnel_01",
#=>                   "tunnelState": 0.5
#=>                 }
#=>               },
#=>               {
#=>                 "avg": {
#=>                   "tunnelState": 0.5
#=>                 },
#=>                 "count": 310,
#=>                 "dimensions": {
#=>                   "edgeColoName": "mel01",
#=>                   "tunnelName": "tunnel_02",
#=>                   "tunnelState": 0.5
#=>                 }
#=>               }
#=>           ]
#=>         }
#=>       ]
#=>     }
#=>   },
#=>   "errors": null
#=> }

詳細は Analytics API トークンの設定を参照してください。 ↩

GraphQL で Magic Transit のトンネルヘルスチェック結果を照会する

API 呼び出し

Footnotes