-
响应示例 返回状态码为200:接口调用成功,响应体参考InterfacePerformanceResp。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : [
{
"mac" : "xx:xx:xx:xx:xx:xx",
"interfacePackets" : [
{
"interfaceName" : "interface1",
"outBandwidth" : "10",
"inputBandwidth" : "80",
"upwardTraffic" : 100,
"downwardTraffic" : 100
}
]
}
]
} 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/interfaceperformance/device/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?interfaceName=interface1 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
-
URI /controller/campus/v1/performanceservice/basicperformance/interfaceperformance/device/{deviceId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceName 是 string - - 接口名称。 "interface1"
-
响应参数 返回状态码为200:接口调用成功,响应体参考InterfacePerformanceResp。 表3 InterfacePerformanceResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 查询接口的性能数据。 - 表4 InterfacePerformance对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mac string 0~256个字符。 - MAC地址。 "xx:xx:xx:xx:xx:xx" interfacePackets REFERENCE 详细请参见表5。 接口速率信息 - 表5 interfacePackets对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string 0~256个字符。 - 接口名称。 "interface1" outBandwidth string 0~256个字符。 - 出方向宽带占用率。 "10" inputBandwidth string 0~256个字符。 - 入方向宽带占用率。 "80" upwardTraffic int64 [0-2147483647] - 上行流量(最新采集周期内增量值)。 100 downwardTraffic int64 [0-2147483647] - 下行流量(最新采集周期内增量值)。 100 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
-
URI /controller/campus/v1/performanceservice/basicperformance/queryDeviceAlarm 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,UUID格式。 - pageSize 是 integer - - 每页数据量 - pageNo 是 integer - - 当前页 -
-
响应参数 返回状态码为200:接口调用成功,响应体参考DeviceAlarmInfoResponse。 表2 DeviceAlarmInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码 "0" errmsg string 0~256个字符。 - 错误信息。 "" total int32 - - 数据总条数 100 data ARRAY_REFERENCE 详细请参见表3。 数据集合 - 表3 DeviceAlarmInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceMac string - - 设备mac地址 "" deviceName string - - 设备名 "" siteName string - - 站点 "" alarmName string - - 告警 "" alarmLevel string - - 告警级别 "" alarmSuggestions string - - 告警判断 "" occurTime string - - 告警产生时间 "0" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:接口调用成功,响应体参考DeviceAlarmInfoResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"total" : 100,
"data" : [
{
"deviceMac" : "",
"deviceName" : "",
"siteName" : "",
"alarmName" : "",
"alarmLevel" : "",
"alarmSuggestions" : "",
"occurTime" : "0"
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/queryDeviceAlarm?deviceId= &pageSize= &pageNo= HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应示例 返回状态码为200:接口调用成功,响应体参考DevicePerformanceResp。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : [
{
"id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca",
"name" : "device1",
"esn" : "1102350DMJ1111111111",
"deviceIp" : "10.190.12.10",
"neType" : "S5320-52P-SI-AC",
"status" : 0,
"gisLon" : 120.1,
"gisLat" : 10.2,
"traffic" : 10.2,
"onlineUsers" : 10,
"cpuRate" : 10,
"memoryRate" : 10,
"upwardSpeed" : 10.2,
"downwardSpeed" : 10.2,
"mac" : "xx:xx:xx:xx:xx:xx",
"timestamp" : 1687854074
}
]
} 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/device/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应参数 返回状态码为200:接口调用成功,响应体参考DevicePerformanceResp。 表2 DevicePerformanceResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表3。 查询到的网络速率信息。 - 表3 DevicePerformance对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~256个字符。 - 设备标识。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" name string 0~256个字符。 - 设备名称。 "device1" esn string 0~256个字符。 - 设备ESN号。 "1102350DMJ1111111111" deviceIp string 0~256个字符。 - 设备IP。 "10.190.12.10" neType string 0~256个字符。 - 具体的设备款型。 "S5320-52P-SI-AC" status integer [0-10] - 设备状态,0---在线、1---告警、2---故障、3---离线、4---未注册。 0 gisLon number [0-340282350000000000000000000000000000000] - 设备位置经度。 120.1 gisLat number [0-340282350000000000000000000000000000000] - 设备位置纬度。 10.2 traffic number [0-340282350000000000000000000000000000000] - 总流量,单位:字节。 10.2 onlineUsers integer [0-2147483647] - 终端连接数。 10 cpuRate integer [0-100] - CPU利用率,单位:百分比。 10 memoryRate integer [0-100] - 内存利用率,单位:百分比。 10 upwardSpeed number [0-340282350000000000000000000000000000000] - 上行速率,单位:bps。 10.2 downwardSpeed number [0-340282350000000000000000000000000000000] - 下行速率,单位:bps。 10.2 mac string 0~256个字符。 - MAC地址。 "xx:xx:xx:xx:xx:xx" timestamp int64 [0-1988121600] - 最近一次上报的时间戳 1687854074 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
-
响应参数 返回状态码为200:接口调用成功,响应体参考SiteStationStatisticResp。 表3 SiteStationStatisticResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 查询到的站点下设备连接终端数信息。 - 表4 SiteStationStatisticInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [0-2147483647] - 格林威治时间。 1537407600 user24G int32 [0-2147483647] - 2.4G用户数量。 1 user5G int32 [0-2147483647] - 5G用户数量。 0 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:接口调用成功,响应体参考SiteStationStatisticResp。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : [
{
"timestamp" : 1537407600,
"user24G" : 1,
"user5G" : 0
}
]
} 返回状态码为400:参数非法,查询失败。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
URI /controller/campus/v1/performanceservice/basicperformance/station/sites/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 timeDimension 是 string day week month year day 统计周期,day---天、week---周、month---月、year---年。 "day" beginTime 是 int64 [0-2208959999] - 起始格林威治时间(时间精度对应到秒)。 1537408636 endTime 是 int64 [0-2208959999] - 结束格林威治时间(时间精度对应到秒)。 1537495036 deviceType 是 string AP FW AC ALL AP 查询过滤的设备类型,AP---AP设备、FW---FW设备、AC---AC(Fit AP)设备、ALL---所有设备。 "AP"
-
请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/station/sites/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?timeDimension=day&beginTime=1537408636&endTime=1537495036&deviceType=AP HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy