查询带宽流量监控v3
更新时间 2026-07-10 14:49:27
最近更新时间: 2026-07-10 14:49:27
接口功能介绍
- 查询指定带宽在时间区间内的上下行流量监控数据。- 速率单位仅支持 Gb、Mb、Kb 三种（对应 Gbit/s、Mbit/s、Kbit/s）。- 响应字段 upstream 表示上行流量（出网带宽），downstream 表示下行流量（入网带宽）。- 响应 data 字段：key 为 Unix 时间戳（秒），value 为对应时间点的速率值（字符串形式的浮点数，如 "0.0"、"9.117126E-5"）。- startTime 必须严格小于 endTime。- 接口会根据时间区间长度自动选择步长（step），规则如下： - 区间 ≤ 3 小时：步长 60s（1 分钟）。 - 3 小时 < 区间 ≤ 3 天：步长 60s（1 分钟）。 - 3 天 < 区间 ≤ 7 天：步长 300s（5 分钟）。 - 7 天 < 区间 ≤ 15 天：步长 900s（15 分钟）。 - 区间 > 15 天：步长 3600s（1 小时）。
接口约束
无
URI
GET /v3/bandwidth/describeBandwidthTrafficMonitor
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| bandwidthOid | 是 | String | 带宽ID | ||
| startTime | 是 | Long | 查询开始时间（毫秒时间戳）。必须严格小于 endTime。 | 1700000000000 | |
| endTime | 是 | Long | 查询结束时间（毫秒时间戳）。 | 1700003600000 | |
| unit | 是 | String | 速率单位，可选 Gb、Mb、Kb | Mb |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | Integer | 状态码。可能值： - 0: 请求成功。 - 非0：请求失败。 | 0 | |
| msg | String | 返回消息（如有必要） | ||
| data | Object | 返回数据对象 | data |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| unit | String | 速率单位。取值范围：Gb（Gbit/s）、Mb（Mbit/s）、Kb（Kbit/s） | ||
| upstream | Object | 上行流量（出网带宽）数据 | upstream | |
| downstream | Object | 下行流量（入网带宽）数据 | downstream |
表 upstream
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 时序数据。key 为 Unix 时间戳（秒），value 为对应时间点的速率值，字符串形式的浮点数（保留原精度，如 "0.0"、"9.117126E-5"）。无流量时为 "0.0"。 |
表 downstream
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 时序数据。key 为 Unix 时间戳（秒），value 为对应时间点的速率值，字符串形式的浮点数（保留原精度，如 "0.0"、"1.7295837E-4"）。无流量时为 "0.0"。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&bandwidthOid=xxx&startTime=1700000000000&endTime=1700003600000&unit=Mb
请求头header
无
请求体body
无
响应示例
{
"code":0,
"data":{
"unit":"Mb",
"upstream":{
"data":{
"1780555260":"0.0",
"1780555440":9.117126E-5,
"1780555740":1.0147095E-4
}
},
"downstream":{
"data":{
"1780555260":"0.0",
"1780555440":1.7295837E-4,
"1780555740":2.5E-5
}
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
