1)接口功能介绍
查询用户在指定时间段内使用的带宽信息。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/describeUserBandWidthData。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
startTime | 否 | String | 开始时间(Unix时间戳,秒),startTime和endTime均为空时,默认返回最近5分钟的数据 | 1342342343 | |
endTime | 否 | String | 结束时间(Unix时间戳,秒),startTime和endTime均为空时,默认返回最近5分钟的数据 | 1342342343 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bandWidthMonitorData | 是 | List | 带宽监控数据 | * | bandWidthMonitorData |
maxDownBandWidth | 是 | String | 查询时间范围内最大下行带宽,单位:bit/s | 12132 | |
maxUpBandWidth | 是 | String | 查询时间范围内最大下行带宽,单位:bit/s | 12132 |
表 dandWidthMonitorData
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
downBandWidth | 是 | String | 下行带宽,单位:bit/s | 121212 | |
internetRX | 是 | String | 实例接收的公网数据流量,单位:bits | 234324 | |
internetTX | 是 | String | 实例发送的公网数据流量,单位:bits | 234324 | |
timeStamp | 是 | String | 查询监控信息的时间 | 1212234324 | |
upBandWidth | 是 | String | 上行带宽,单位:bit/s | 1212234324 |
6)请求示例
GET https://{host}/v1/describeUserBandWidthData?nodeCode=yn-lincang-1&startTime=1669824000&endTime=1669824300
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"bandWidthMonitorData": [
{
"upBandWidth": "829",
"internetTX": "480",
"downBandWidth": "829",
"timeStamp": "1669971142",
"internetRX": "480"
}
],
"maxDownBandWidth": "829",
"maxUpBandWidth": "829"
},
"requestId": "d0a94e2d-8202-462e-8eeb-c5784daf605a"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |