文档首页
API docs by Redocly

爱快 OpenAPI - 监控 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

来源于 ikuai-doc/openapi_specs/monitor/。

为避免 Redoc 单页一次性加载全部 API 导致浏览器 heap 过高，部署版按分类拆分。

摄像头监控API

来源文件: monitor/monitor-cameras.json

查询摄像头设备列表

查询摄像头设备列表，支持分页和过滤。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 50
Example: limit=50

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=id

排序字段，支持id、tagname、name、ip_addr、vendor、status等字段

filter
string
Example: filter=status==0

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 设备类型过滤：filter=flag==1
  • 在线状态过滤：filter=status==0
  • IP地址过滤：filter=ip_addr==192.168.1.100
key
string
Example: key=name,ip_addr,vendor

模糊匹配字段列表，支持 tagname, name, ip_addr, vendor, version, comment

pattern
string
Example: pattern=Hikvision

模糊匹配内容

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

终端监控管理API

来源文件: monitor/monitor-clients.json

获取IPv4终端在线统计

获取当前IPv4在线终端的统计信息，包括MAC地址、SSID、IP地址、 上下行速率、连接数、厂商型号等详细信息。支持分页、过滤和模糊匹配。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 10
Example: limit=10

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=timestamp

排序字段，支持id、timestamp、mac、ip_addr等字段

key
string
Example: key=mac,ip_addr

模糊匹配字段列表，支持 ssid, mac, ip_addr, termname, client_vendor, client_model

pattern
string
Example: pattern=08:9b:4b

模糊匹配内容

filter
string
Example: filter=mac==08:9b:4b:01:7e:7c

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"
  • "：（包含）"
  • "!：（不包含）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 单条件：filter=mac==08:9b:4b:01:7e:7c
  • AND条件：filter=interface==lan1&filter=connect_num>1
  • OR条件：filter=mac==08:9b:4b:01:7e:7c,mac==08:9b:4b:13:35:6f
  • 包含过滤：filter=client_vendor:Apple
  • 时间范围：filter=timestamp>1763804000&filter=timestamp<1763805000

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取IPv6终端在线统计

获取当前IPv6在线终端的统计信息，包括MAC地址、SSID、IP地址、 上下行速率、连接数、厂商型号等详细信息。支持分页、过滤和模糊匹配。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 10
Example: limit=10

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=timestamp

排序字段，支持id、timestamp、mac、ip_addr等字段

key
string
Example: key=mac,ip_addr

模糊匹配字段列表，支持 ssid, mac, ip_addr, termname, client_vendor, client_model

pattern
string
Example: pattern=08:9b:4b

模糊匹配内容

filter
string
Example: filter=mac==08:9b:4b:01:7e:7c

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"
  • "：（包含）"
  • "!：（不包含）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 单条件：filter=mac==08:9b:4b:01:7e:7c
  • AND条件：filter=interface==lan1&filter=connect_num>1
  • OR条件：filter=mac==08:9b:4b:01:7e:7c,mac==08:9b:4b:13:35:6f
  • 包含过滤：filter=client_vendor:Apple
  • 时间范围：filter=timestamp>1763804000&filter=timestamp<1763805000

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取IPv4终端离线统计

获取IPv4离线终端的统计信息，包括MAC地址、IP地址、下线时间、 总流量统计、认证类型等详细信息。支持分页、过滤和模糊匹配。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 10
Example: limit=10

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=timestamp

排序字段，支持id、timestamp、mac、ip_addr等字段

key
string
Example: key=mac,ip_addr

模糊匹配字段列表，支持 mac, ip_addr, termname, client_vendor, client_model

pattern
string
Example: pattern=52:83:56

模糊匹配内容

filter
string
Example: filter=mac==52:83:56:ef:f2:4b

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"
  • "：（包含）"
  • "!：（不包含）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 单条件：filter=mac==52:83:56:ef:f2:4b
  • AND条件：filter=logout_time>1763814000&filter=total_up>0
  • OR条件：filter=mac==52:83:56:ef:f2:4b,mac==08:9b:4b:01:7e:7c
  • 包含过滤：filter=client_vendor:Apple
  • 时间范围：filter=logout_time>1763814000&filter=logout_time<1763815000

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取IPv6终端离线统计

获取IPv6离线终端的统计信息，包括MAC地址、IP地址、下线时间、 总流量统计、认证类型等详细信息。支持分页、过滤和模糊匹配。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 10
Example: limit=10

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=timestamp

排序字段，支持id、timestamp、mac、ip_addr等字段

key
string
Example: key=mac,ip_addr

模糊匹配字段列表，支持 mac, ip_addr, termname, client_vendor, client_model

pattern
string
Example: pattern=00:71:6f

模糊匹配内容

filter
string
Example: filter=mac==00:71:6f:a6:0c:2d

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"
  • ":（包含）"
  • "!：（不包含）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 单条件：filter=mac==00:71:6f:a6:0c:2d
  • AND条件：filter=logout_time>1773390000&filter=total_up>0
  • OR条件：filter=mac==00:71:6f:a6:0c:2d,mac==08:9b:4b:01:7e:7c
  • 包含过滤：filter=client_vendor:iKuai
  • 时间范围：filter=logout_time>1773390000&filter=logout_time<1773391000

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取终端当日流量统计

获取所有终端的当日流量统计信息，包括总流量、上行流量、 下行流量等汇总数据。支持分页功能，不支持key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 10
Example: limit=10

每页记录数

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取指定终端的5分钟流量负载

获取指定终端的5分钟流量负载，包含上行速率和下行速率， 5秒一个数据点，共300个数据点。ip和mac均必须输入。

Authorizations:
bearerAuth
query Parameters
mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
Example: mac=08:9b:4b:01:7e:7c

终端MAC地址

ip
required
string <ipv4>
Example: ip=192.168.9.199

终端IP地址

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取指定终端的协议分类流量统计

获取指定终端最近24小时的协议分类流量统计。 协议大类包括：网络协议、传输下载、休闲娱乐、生活服务、办公协作、 社交通讯、效率工具、网络游戏、金融理财、学习教育等。 mac和ip必须输入，不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
Example: mac=08:9b:4b:01:7e:7c

终端MAC地址

ip
required
string
Example: ip=192.168.9.199

终端IP地址

starttime
integer
Example: starttime=1773304236

开始时间戳

stoptime
integer
Example: stoptime=1773304246

结束时间戳

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取指定终端的协议分类历史速率

获取指定终端最近24小时的协议分类速率负载，每5分钟一个数据点， 包含各协议分类的上下行速率信息，单位字节/秒。 mac和ip必须输入，不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
mac
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
Example: mac=08:9b:4b:01:7e:7c

终端MAC地址

ip
required
string
Example: ip=192.168.9.199

终端IP地址

starttime
integer
Example: starttime=1773304236

开始时间戳

stoptime
integer
Example: stoptime=1773304246

结束时间戳

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取指定终端当前应用协议速率统计

查询指定终端当前访问的所有应用协议的速率和流量信息， 包括连接数、上下行速率、总流量及协议分类信息。 mac 和 ip 必须输入，支持分页。

Authorizations:
bearerAuth
query Parameters
mac
required
string
Example: mac=08:9b:4b:01:7e:7c

终端MAC地址

ip
required
string <ipv4>
Example: ip=192.168.9.199

终端IP地址

page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页返回数量

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

分流监控API

来源文件: monitor/monitor-flow-shunting.json

查询分流统计数据

查询分流监控统计数据，包含今日、昨日、最近7天的连接数统计。

TYPE 参数：

  • data: 统计数据（默认）
Authorizations:
bearerAuth
query Parameters
TYPE
string
Default: "data"
Value: "data"

返回数据类型

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

接口监控管理API

来源文件: monitor/monitor-interfaces.json

获取线路状态监控

获取所有网络接口的线路状态信息，包括线路检查结果（iface_check）和 流量统计信息（iface_stream）。包含连接状态、IP地址、网关、 线路检测结果、自动切换状态、实时流量等详细信息。 不支持query参数。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取线路最近24小时流量负载监控

获取线路最近24小时的流量统计数据，包括最大/平均上传下载速率、 丢包率、往返时延等网络质量指标。支持多线路汇总数据。 不支持limit、page、order、key、pattern、filter参数。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取内外网接口配置监控

获取内网（LAN）和外网（WAN）接口的配置快照信息，包括接口名称、 MAC地址、IP地址、子网掩码、网关、DNS、接入模式、绑定模式等详细配置。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取物理网卡列表

查询物理网卡列表和网卡对应的属性信息，包括驱动、网卡类型、 MAC地址、连接状态、协商速率、双工模式、网卡型号及所属接口等。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取IPv6线路详情

查询IPv6线路详情，包括wan线路IPv6的转发流量负载， 包含连接数、上行速率、下行速率、总上行流量、总下行流量等信息。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

负载监控API

来源文件: monitor/monitor-load.json

获取系统实时状态信息

获取路由系统的实时状态信息，包括CPU、内存、连接数、流量、版本等。 无需传入参数。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取CPU负载监控数据

获取指定时间范围内的CPU负载监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取内存使用监控数据

获取指定时间范围内的内存使用监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取磁盘空间使用监控数据

获取指定时间范围内的磁盘空间使用监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取在线终端数监控数据

获取指定时间范围内的在线终端数监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取连接数监控数据

获取指定时间范围内的连接数监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取系统温度监控数据

获取指定时间范围内的系统温度监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取网络负载监控数据

获取指定时间范围内的网络负载监控数据。 支持按小时、天、周、月进行数据聚合，可选择平均值或最大值。

Authorizations:
bearerAuth
query Parameters
datetype
required
string
Enum: "hour" "day" "week" "month"
Example: datetype=hour

数据聚合类型

start_time
required
integer <int64>
Example: start_time=1763532000

开始时间戳

end_time
required
integer <int64>
Example: end_time=1763536500

结束时间戳

math
required
string
Enum: "avg" "max"
Example: math=avg

数学计算方式

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

周边设备监控API

来源文件: monitor/monitor-peripheral-devices.json

查询周边设备列表

查询周边设备列表，支持分页、过滤和设备类型筛选。

设备类型筛选（device参数）：

  • router: 路由器
  • switches: 交换机
  • firewall: 防火墙
  • server: 服务器
  • camera: 摄像头
  • printer: 打印机
  • SmartDevices: 智能设备
  • ap: 无线AP
  • other: 其他
Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 50
Example: limit=50

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=id

排序字段，支持id、name、ip_addr、status、last_time等字段

filter
string
Example: filter=device==camera

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 设备类型过滤：filter=device==camera
  • 在线状态过滤：filter=status==1
  • IP地址过滤：filter=ip_addr==192.168.1.100
key
string
Example: key=name,ip_addr

模糊匹配字段列表，支持 name, tagname, ip_addr, mac, device, access

pattern
string
Example: pattern=192.168

模糊匹配内容

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

应用协议监控管理API

来源文件: monitor/monitor-proto.json

获取最近24小时应用协议流量统计

获取最近24小时的应用协议流量统计信息，包括应用名称、分类、 总流量、上下行流量等详细数据。支持分页查询，不支持key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取最近24小时协议分类流量汇总

查询最近24小时协议分类的流量使用详情，返回各协议大类的流量汇总。 协议大类包括：网络协议、传输下载、休闲娱乐、生活服务、办公协作、 社交通讯、效率工具、网络游戏、金融理财、学习教育等。 支持时间段范围查询，不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
starttime
integer <int64>
Example: starttime=1773215100

查询起始时间戳（Unix时间戳）

stoptime
integer <int64>
Example: stoptime=1773215100

查询结束时间戳（Unix时间戳）

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取协议分类历史速率

查询最近24小时协议分类的速率使用详情，每5分钟一个数据点。 返回各协议分类的上下行速率、总流量、连接数等信息。 支持时间段范围查询（可选），不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
starttime
integer <int64>
Example: starttime=1773215100

查询起始时间戳（Unix时间戳，可选）

stoptime
integer <int64>
Example: stoptime=1773215100

查询结束时间戳（Unix时间戳，可选）

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取当前应用协议速率使用详情

查询当前各应用协议的速率使用详情，包括当前连接数、上下行速率、总流量等。 支持分页查询，支持按上下行流量进行排序，不支持key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=desc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "total_down"
Enum: "upload" "download" "total_up" "total_down"
Example: order_by=total_down

排序字段，支持按上行（upload、total_up）或下行（download、total_down）流量排序

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取应用协议历史速率使用详情

查询指定应用协议的最近24小时历史速率使用详情，每5分钟一个数据点。 例如可查询微信、QQ的最近24小时历史速率负载。 支持时间段范围查询，必须指定应用协议ID（appids），支持多个ID以逗号分隔。 不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
starttime
integer <int64>
Example: starttime=1773215100

查询起始时间戳（Unix时间戳，可选）

stoptime
integer <int64>
Example: stoptime=1773215100

查询结束时间戳（Unix时间戳，可选）

appids
required
string
Example: appids=2580003,2580004

应用协议ID，必须指定，支持多个ID以逗号分隔（如 2580003,2580004）

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取访问指定应用协议的终端列表

查询有哪些终端访问过指定的应用协议，列出终端当前的上下行速率、 总流量、连接数、主机名、MAC地址等信息。 必须指定应用协议ID（appid）。 不支持limit、page、key、pattern、filter。

Authorizations:
bearerAuth
query Parameters
appid
required
integer <int64>
Example: appid=2580003

应用协议ID，必须指定

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

云管交换机监控API

来源文件: monitor/monitor-switch.json

查询云管交换机设备列表

查询云管交换机设备列表，支持分页和过滤。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 50
Example: limit=50

每页记录数

order
string
Default: "asc"
Enum: "asc" "desc"
Example: order=asc

排序方向，asc为升序（默认），desc为降序

order_by
string
Default: "id"
Example: order_by=id

排序字段，支持id、name、ip_addr、status、connect_time等字段

filter
string
Example: filter=status==1

过滤条件，支持精确匹配和多条件组合。

支持的操作符：

  • "==（等于）"
  • "!=（不等于）"
  • ">（大于）"
  • ">=（大于等于）"
  • "<（小于）"
  • "<=（小于等于）"

多条件连接语法：

  • AND逻辑：filter=field1==value1&filter=field2==value2
  • OR逻辑：filter=field1==value1,field2==value2

使用示例：

  • 在线状态过滤：filter=status==1
  • 设备类型过滤：filter=type==IK_J7052
  • IP地址过滤：filter=ip_addr==192.168.1.100
key
string
Example: key=name,ip_addr,mac

模糊匹配字段列表，支持 name, tagname, ip_addr, mac, device, oemname

pattern
string
Example: pattern=交换机

模糊匹配内容

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

流量审计监控API

来源文件: monitor/monitor-traffic-audit.json

查询 MAC 流量审计列表

查询 MAC 终端维度的流量审计统计列表。 数据按 MAC 聚合，返回累计上行、累计下行等信息，可按时间范围查询。

Authorizations:
bearerAuth
query Parameters
limit
string^\\d+,\\d+$
Default: "0,50"
Example: limit=0,50

分页参数，格式为 offset,count

starttime
integer <int64>
Example: starttime=1778121610

查询起始时间戳

stoptime
integer <int64>
Example: stoptime=1778125210

查询结束时间戳

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

查询指定 MAC 流量趋势详情

查询指定 MAC 终端的流量趋势详情。 返回 IPv4 日流量统计数据，并在存在 IPv6 统计数据时同步返回 IPv6 日流量统计数据。 终端身份由查询参数 mac 确定，结果默认按统计日期升序返回。

Authorizations:
bearerAuth
query Parameters
mac
required
string^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
Example: mac=68:da:73:a1:d9:01

MAC 地址

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

查询指定 MAC 应用流量详情

查询指定 MAC 终端的应用流量明细。

  • method=day（默认）：返回最近 7 天数据，无需传 starttime/stoptime
  • method=hour：可选传入 starttime/stoptime，未传时默认返回最近 1 小时数据 返回格式为时间戳到应用流量映射，每条记录按时间升序排列。
Authorizations:
bearerAuth
query Parameters
mac
required
string^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$
Example: mac=68:da:73:a1:d9:01

MAC 地址

method
string
Default: "day"
Enum: "hour" "day"
Example: method=hour

应用流量统计粒度，不传时按日统计

starttime
integer <int64>
Example: starttime=1778083200

查询起始时间戳（仅 method=hour 时有效，不传默认为当前时间前 1 小时）

stoptime
integer <int64>
Example: stoptime=1778169600

查询结束时间戳（仅 method=hour 时有效，不传默认为当前时间）

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

查询账号流量审计列表

查询认证账号维度的流量审计统计列表。 数据按账号聚合，返回累计上行、累计下行等信息，可按时间范围查询。

Authorizations:
bearerAuth
query Parameters
limit
string^\\d+,\\d+$
Default: "0,50"
Example: limit=0,50

分页参数，格式为 offset,count

starttime
integer <int64>
Example: starttime=1778121610

查询起始时间戳

stoptime
integer <int64>
Example: stoptime=1778125210

查询结束时间戳

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

查询指定账号流量趋势详情

查询指定认证账号的流量趋势详情，返回账号维度的日流量统计数据，结果默认按统计日期升序返回。

Authorizations:
bearerAuth
query Parameters
username
required
string
Example: username=vpn_user01

认证账号名称

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

查询指定账号应用流量详情

查询指定认证账号的应用流量明细。

  • method=day（默认）：返回最近 7 天数据，无需传 starttime/stoptime
  • method=hour：可选传入 starttime/stoptime，未传时默认返回最近 1 小时数据 返回格式为时间戳到应用流量映射，每条记录按时间升序排列。
Authorizations:
bearerAuth
query Parameters
username
required
string
Example: username=vpn_user01

认证账号名称

method
string
Default: "day"
Enum: "hour" "day"
Example: method=hour

应用流量统计粒度，不传时按日统计

starttime
integer <int64>
Example: starttime=1778083200

查询起始时间戳（仅 method=hour 时有效，不传默认为当前时间前 1 小时）

stoptime
integer <int64>
Example: stoptime=1778169600

查询结束时间戳（仅 method=hour 时有效，不传默认为当前时间）

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

无线监控管理API

来源文件: monitor/monitor-wireless.json

获取无线监控统计信息

获取无线网络的统计数据，包括AP状态统计和客户端状态统计， 如AP在线数量、终端数量、频段分布等信息。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取无线流量统计

获取最近24小时内AP设备的无线流量统计数据，包括五分钟累计流量和实时上下行速率。 可通过apmac参数过滤指定AP的数据，不提供则汇总所有AP数据。

Authorizations:
bearerAuth
query Parameters
apmac
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
Example: apmac=00:00:00:00:00:00

AP设备MAC地址，不提供则汇总所有AP数据

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取无线网络评分

获取最近24小时内无线网络质量评分，包括用户活跃度、空口健康度、信道负载、 关联稳定度、延迟、信号覆盖度、丢包率等评分指标。

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取SSID终端统计

获取各SSID的终端连接历史统计信息，按每小时汇总。 可通过ssid参数过滤指定SSID的数据，不提供则返回所有SSID数据。

Authorizations:
bearerAuth
query Parameters
ssid
string <= 100 characters
Example: ssid=iKuai01_2G

SSID名称，不提供则返回所有SSID数据

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

获取信道终端统计

获取各信道的终端连接历史统计信息，按每小时汇总。 可通过channel参数过滤指定信道的数据，不提供则返回所有信道数据。

Authorizations:
bearerAuth
query Parameters
channel
integer [ 1 .. 165 ]
Example: channel=1

无线信道号，不提供则返回所有信道数据

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}