文档首页/Web应用防火墙 WAF/API参考（联盟区域）/API/安全总览/查询安全统计带宽数据
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询安全统计带宽数据

功能介绍

查询安全统计带宽数据，统计的带宽数据为平均值，单位为bit/s。

URI

GET /v1/{project_id}/waf/overviews/bandwidth/timeline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id

from

是

Long

查询的带宽统计数据的起始时间（13位毫秒时间戳），需要和to同时使用

to

是

Long

查询的带宽统计数据的结束时间（13位毫秒时间戳），需要和from同时使用

hosts

否

String

域名id，用于查询指定的防护域名在from到to这段时间内的带宽数据。通过查询云模式防护域名列表（ListHost）获取域名id或者通过独享模式域名列表（ListPremiumHost）获取域名id

instances

否

String

引擎实例id，用于查询指定的独享引擎实例所防护的域名在from到to这段时间内的带宽数据。

group_by

否

String

展示维度，按天展示时传"DAY"；默认不传，按照分钟展示。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

是

String

内容类型

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of BandwidthStatisticsTimelineItem objects

带宽时间线统计数据，包括带宽（BANDWIDTH）、入带宽（IN_BANDWIDTH）以及出带宽（OUT_BANDWIDTH）统计数据。

表5 BandwidthStatisticsTimelineItem

参数

参数类型

描述

key

String

键值，其值包括带宽（BANDWIDTH）、入带宽（IN_BANDWIDTH）以及出带宽（OUT_BANDWIDTH）

timeline

Array of TimeLineItem objects

对应键值的时间线统计数据，包含两个字段，time字段值为时间点；num字段为time对应时间点与前一时间点间隔内的统计数值

表6 TimeLineItem

参数

参数类型

描述

time

Long

时间点

num

Integer

time对应时间点与前一时间点间隔内的统计数值。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询项目id为project_id，时间从2022-04-21 00:00:00到2022-04-21 14:35:36的安全统计带宽数据

GET https://{Endpoint}/v1/{project_id}/waf/overviews/bandwidth/timeline?enterprise_project_id=0&from=1650470400196&to=1650522936196

响应示例

状态码：200

ok

[ {
  "key" : "IN_BANDWIDTH",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "OUT_BANDWIDTH",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "BANDWIDTH",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
} ]

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题：安全总览