使用 GraphQL 查询 Cloudflare WAN IPsec/GRE 隧道带宽分析

此示例使用 GraphQL Analytics API 来查询指定时间段内的 Cloudflare WAN 入口隧道流量。

以下 API 调用请求一小时时间段内的 Cloudflare WAN 入口隧道流量，并输出请求的字段。将 <CLOUDFLARE_ACCOUNT_TAG> 替换为您的账户 ID，将 <EMAIL>、<API_KEY>¹（旧版）或 <API_TOKEN>²（首选）替换为您的 API 凭据，并根据需要调整 datetime_geq 和 datetime_leq 的值。

该示例查询的是入口（ingress）流量。要查询出口（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"
    }
  }
}'

# 使用旧版 API Key 的 curl
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)"

# 使用 API Token 的 curl
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)"

返回的值代表特定隧道在五分钟间隔内的总带宽（以比特/秒为单位）。要使用五分钟以外的聚合，请对您的指标和日期时间使用相同的时间窗口。例如，要分析每小时分组，请使用 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 .

## 示例响应：
#=> {
#=>   "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