跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

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

最后更新 查看 MarkdownAgent 设置

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

以下 API 调用请求一小时内的 Cloudflare WAN 入站隧道流量,并输出所请求的字段。将 <CLOUDFLARE_ACCOUNT_TAG> 替换为你的账户 ID,将 <EMAIL>、<API_KEY>1(旧版)或 <API_TOKEN>2(推荐)替换为 API 凭据,并根据需要调整 datetime_geq 和 datetime_leq 值。

此示例查询入站流量。要查询出站流量,请更改 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)"

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

Footnotes

  1. 有关详细信息,请参阅使用 Cloudflare API 密钥进行认证。 ↩

  2. 有关详细信息,请参阅配置 Analytics API 令牌。 ↩

这篇文档对您有帮助吗?