文档首页
API docs by Redocly

爱快 OpenAPI - 日志 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

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

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

ARP日志管理API

来源文件: log/log-arp.json

获取ARP日志列表

获取ARP日志记录列表。 支持过滤和分页功能，可以查询ARP地址欺骗等安全事件。

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=asc

排序方向

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

排序字段

key
string
Example: key=content

模糊匹配字段列表，支持 content

pattern
string
Example: pattern=地址欺骗

模糊匹配内容

filter
string
Example: filter=id==1

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=id==1
  • AND条件：filter=id>100&filter=timestamp<1736475000
  • OR条件：filter=content==欺骗,content==攻击
  • 时间范围：filter=timestamp>1736472000&filter=timestamp<1736475000

Responses

Response samples

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

删除ARP日志

清空所有ARP日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

认证日志管理API

来源文件: log/log-auth.json

获取认证日志列表

获取用户认证日志记录列表。 支持过滤和分页功能，可以查询不同类型的VPN认证记录。

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

排序方向

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

排序字段

key
string
Example: key=username,macip

模糊匹配字段列表，支持 username, macip, ip_addr

pattern
string
Example: pattern=test001

模糊匹配内容

filter
string
Example: filter=ppptype==l2tp

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=ppptype==l2tp
  • AND条件：filter=ppptype==l2tp&filter=result==认证成功
  • OR条件：filter=username==test001,username==test002
  • 时间范围：filter=timestamp>1736474000&filter=timestamp<1736528000

Responses

Response samples

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

清空认证日志

清空所有用户认证日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

动态域名日志管理API

来源文件: log/log-ddns.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=timestamp

排序字段，支持id、timestamp、status等字段

filter
string
Example: filter=status==success

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=status==success
  • AND条件：filter=status==success&filter=domain==example.com
  • OR条件：filter=status==success,status==failure
  • 时间范围：filter=timestamp>1763450000&filter=timestamp<1763455000
key
string
Example: key=domain,status

模糊匹配字段列表，支持 domain, status, message

pattern
string
Example: pattern=example.com

模糊匹配内容

Responses

Response samples

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

清空动态域名日志

清空所有动态域名日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

DHCP日志管理API

来源文件: log/log-dhcp.json

获取DHCP日志列表

获取DHCP日志记录列表。 支持过滤和分页功能，可以查询DHCP协议交互等记录。

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=timestamp

排序字段，支持id、timestamp、msgtype、interface等字段

filter
string
Example: filter=msgtype==DHCPACK

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=msgtype==DHCPACK
  • AND条件：filter=msgtype==DHCPACK&filter=interface==lan1
  • OR条件：filter=msgtype==DHCPACK,msgtype==DHCPOFFER
  • MAC地址过滤：filter=mac==a6:8d:9a:61:96:90
  • 时间范围：filter=timestamp>1761842000&filter=timestamp<1761843000
key
string
Example: key=msgtype,interface

模糊匹配字段列表，支持 msgtype, interface, ip_addr, mac

pattern
string
Example: pattern=DHCPACK

模糊匹配内容

Responses

Response samples

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

清空DHCP日志

清空所有DHCP日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

消息中心API

来源文件: log/log-message-center.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: "desc"
Enum: "asc" "desc"
Example: order=desc

排序方向，asc为升序，desc为降序

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

排序字段，支持 id、timestamp、type、status、title

filter
string
Example: filter=status==0

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 消息类型过滤：filter=type==1
  • 未读消息过滤：filter=status==0
  • 时间范围过滤：filter=timestamp>=1778760000&filter=timestamp<1778846400
key
string
Example: key=title,detail

模糊搜索字段名，与 pattern 联合使用，支持 title、detail

pattern
string
Example: pattern=升级

模糊搜索关键词，与 key 联合使用

Responses

Response samples

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

推送通知日志管理API

来源文件: log/log-notice.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=timestamp

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

filter
string
Example: filter=type==email

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=type==email
  • AND条件：filter=type==email&filter=ip_addr==192.168.1.100
  • OR条件：filter=type==email,type==sms
  • 事件过滤：filter=event==通知发送成功
  • 时间范围：filter=timestamp>1762342000&filter=timestamp<1762343000
key
string
Example: key=type,event

模糊匹配字段列表，支持 type, ip_addr, event

pattern
string
Example: pattern=通知

模糊匹配内容

Responses

Response samples

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

清空推送通知日志

清空所有推送通知日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

外网拨号日志管理API

来源文件: log/log-pppoe.json

获取外网拨号日志列表

获取外网拨号日志记录列表。 支持过滤和分页功能，可以查询PPP连接状态等信息。

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=timestamp

排序字段，支持id、timestamp、interface等字段

filter
string
Example: filter=interface==adsl1

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=interface==adsl1
  • AND条件：filter=interface==adsl1&filter=content==pppd
  • OR条件：filter=interface==adsl1,interface==wan2_1
  • 内容过滤：filter=content==Connected
  • 时间范围：filter=timestamp>1762342000&filter=timestamp<1762343000
key
string
Example: key=interface,content

模糊匹配字段列表，支持 interface, content

pattern
string
Example: pattern=pppd

模糊匹配内容

Responses

Response samples

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

清空外网拨号日志

清空所有外网拨号日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

系统日志管理API

来源文件: log/log-system.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=timestamp

排序字段，支持id、timestamp、level、module等字段

filter
string
Example: filter=level==error

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=level==error
  • AND条件：filter=level==error&filter=module==system
  • OR条件：filter=level==error,level==warning
  • 模块过滤：filter=module==kernel
  • 时间范围：filter=timestamp>1763450000&filter=timestamp<1763455000
key
string
Example: key=level,module

模糊匹配字段列表，支持 level, module, message, process

pattern
string
Example: pattern=error

模糊匹配内容

Responses

Response samples

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

清空系统日志

清空所有系统日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

终端上下线日志API

来源文件: log/log-terminal-presence.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=desc

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

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

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

filter
string
Example: filter=ip_addr==192.168.1.100

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=ip_addr==192.168.1.100
  • AND条件：filter=ip_addr==192.168.1.100&filter=mac==08:9b:4b:00:10:6e
  • OR条件：filter=systype==Windows,systype==Android
  • 时间范围：filter=timestamp>1761842000&filter=timestamp<1761843000
key
string
Example: key=ip_addr,mac,username

模糊匹配字段列表，支持 mac, ip_addr, systype, devtype, client_model, comment, username, termname

pattern
string
Example: pattern=192.168.1

模糊匹配内容

starttime
integer <int64>
Example: starttime=1761842000

查询开始时间，Unix 时间戳，非必填，用于限定查询时间范围

stoptime
integer <int64>
Example: stoptime=1761843000

查询结束时间，Unix 时间戳，非必填，用于限定查询时间范围

Responses

Response samples

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

网址浏览记录API

来源文件: log/log-url-visits.json

获取网址浏览记录列表

获取终端网址浏览记录列表。 支持分页、时间范围查询和关键词搜索。 limit 默认 20，最大 500，超过最大值时按 500 处理。 未传入时间范围时默认查询当天 00:00 至当前时间；最大查询跨度为 7 天，超出时自动按 stoptime 向前截取 7 天。 当 limit、starttime 或 stoptime 不符合查询约束时，接口不会直接返回参数错误，而是按上述规则自动调整后再查询。 时间范围较大时，请使用分页参数分批获取，避免单次返回数据过大。

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

页码（从1开始）

limit
integer [ 1 .. 500 ]
Default: 20
Example: limit=20

每页记录数，默认 20，最大 500；超过最大值时服务端按 500 处理

pattern
string
Example: pattern=example.com

搜索关键词，根据索引自动匹配终端 IP、MAC、访问主机名或终端备注

starttime
integer <int64>
Example: starttime=1761842000

查询开始时间，Unix 时间戳，非必填；缺失、格式不合法或晚于 stoptime 时，服务端会自动调整为 stoptime 所在日期的 00:00

stoptime
integer <int64>
Example: stoptime=1761843000

查询结束时间，Unix 时间戳，非必填；缺失、格式不合法或晚于当前时间时，服务端会自动调整为当前时间

Responses

Response samples

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

清空网址浏览记录

清空网址浏览记录。 本接口用于清空全部网址浏览记录，不支持按时间范围清空。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

告警信息API

来源文件: log/log-warnings.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: "desc"
Enum: "asc" "desc"
Example: order=desc

排序方向，asc为升序，desc为降序

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

排序字段，支持 id、timestamp、type、event、level、status、title

filter
string
Example: filter=status==0

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 告警类型过滤：filter=type==1
  • 告警事件过滤：filter=event==CPU
  • 告警等级过滤：filter=level==2
  • 未读告警过滤：filter=status==0
  • 时间范围过滤：filter=timestamp>=1778760000&filter=timestamp<1778846400
key
string
Example: key=title,detail

模糊搜索字段名，与 pattern 联合使用，支持 event、title、detail、customize

pattern
string
Example: pattern=CPU

模糊搜索关键词，与 key 联合使用

Responses

Response samples

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

WEB操作日志管理API

来源文件: log/log-web-activity.json

获取WEB操作日志列表

获取用户WEB操作日志记录列表。 支持过滤和分页功能，可以查询用户登录、配置操作等记录。

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=timestamp

排序字段，支持id、timestamp、username、event等字段

filter
string
Example: filter=event==登录

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=event==登录
  • AND条件：filter=event==登录&filter=username==admin
  • OR条件：filter=event==登录,event==登出
  • 用户过滤：filter=username==admin
  • IP地址过滤：filter=ip_addr==192.168.99.101
  • 时间范围：filter=timestamp>1763779000&filter=timestamp<1763780000
key
string
Example: key=username,event

模糊匹配字段列表，支持 username, ip_addr, function, event

pattern
string
Example: pattern=登录

模糊匹配内容

Responses

Response samples

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

清空WEB操作日志

清空所有WEB操作日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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

无线终端日志管理API

来源文件: log/log-wireless-client.json

获取无线终端日志列表

获取无线终端连接/断开日志记录列表。 支持过滤和分页功能，可以查询客户端的连接状态和信号信息。

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=asc

排序方向

order_by
string
Default: "id"
Enum: "id" "timestamp" "mac" "ssid"
Example: order_by=timestamp

排序字段

key
string
Example: key=mac,ssid

模糊匹配字段列表，支持 mac, ssid, errmsg, mac_comment, apmac_comment

pattern
string
Example: pattern=5G:IK-Work

模糊匹配内容

filter
string
Example: filter=action==login

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

支持的操作符：

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

多条件连接语法：

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

使用示例：

  • 单条件：filter=action==login
  • AND条件：filter=action==login&filter=signal>-50
  • OR条件：filter=mac==de:8e:d0:1f:c1:d6,mac==46:61:43:b4:f6:07
  • 时间范围：filter=timestamp>1763450000&filter=timestamp<1763455000
  • MAC地址过滤：filter=apmac==08:9b:4b:11:22:33

Responses

Response samples

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

清空无线终端日志

清空所有无线终端连接日志记录。 此操作不可恢复，请谨慎操作。

Authorizations:
bearerAuth

Responses

Response samples

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