Shallow API手册
Changelog
Shallow API v1.2.0beta8(下载):
1、优化黑名单列表注入LLM内容优化
2、改进黑名单命中日志查询分页Shallow API v1.2.0beta7(下载):
1、黑名单触发增加 API接口变量 $ros_id,可以执行/ip/firewall/connection remove $ros_id 删除黑名单管理的IP连接;
2、新增黑名单监控触发后,支持删除命中的连接选项;
3、修改黑名单列表文件的载入方式,优化注释读取;Shallow API v1.2.0beta5(下载):
1、重构连接分析页面功能:
支持分析维度选项查看源/目标和流向图;
支持总连接数/srcnat/dstnat统计;
支持协议分布统计;
支持Syn与已建立连接;
支持FastTrack与hw-offload统计;
支持当前连接明细查询。
2、新增黑名单功能:
支持黑名单列表的添加编辑功能;
支持黑名单文件上传;
支持黑名单触发报警统计功能;
支持调用API执行RouterOS命令,例如将触发的黑名单IP加入地址列表 /ip/firewall/address-lst add list=blacklist address=$blacklist_ip comment=$comment Shallow API v1.1.0beta1(下载):
1、重构和优化UI界面,支持白天黑夜模式切换
2、新增支持证书上传和管理功能
3、补充相关操作的日志记录
4、启动默认使用https服务(https://IP:6636),证书为选用初始化时的自签证书Shallow API v1.0.5 (下载):
1、改造网络接口数据结构,将一台设备的所有接口数据归为一个json字段,减少数据库条目
2、新增RxByteAvg/TxByteAvg,txDropAvg/rxDropAvg,txErrorAvg\rxErrorAvg,txQueueDropAvg网络接口数据采集
3、智能体对话聊天框支持markdown格式
4、新增向智能体注入1,3,6,12,24小时系统和网络数据,并让LLM生成简报功能
5、新增计划任务支持LLM生成简报定时任务,并支持选择需要执行简报的设备
6、新增智能体对话,支持后台任务执行和状态显示,避免切换窗口导致对话中断Shallow API v1.0.4 (下载):
1、QQBot配置AppSecret加密存储
2、仪表盘增加设备卡片的智能体对话按钮
3、计划任务新增每日定时执行功能
4、计划任务新增智能体根据指定内容通知功能Shallow API v1.0.3 (下载):
1、修复风险拦截级别的default规则重启服务后复位的问题
2、增加QQ机器人功能,支持接入QQ机器人与智能体沟通,获取RouterOS设备运行状态。如果涉及具体配置,仍然需要在本地shallow API的智能体对话框确认执行Shallow API v1.0.1beta2 (下载):
1、支持主流LLM大语言模型接入,通过LLM Provider管理;
2、增加风险拦截级别,对执行命令进行高中风险拦截,支持白名单命令;
3、完成智能体对话接入,当查询RouterOS运行状态时,会优先将本地采集数据推送给LLM,不用单独执行命令查询;
4、添加策略操作单,支持智能体创建本地监控策略。Shallow API v0.0.7beta27 (下载):
1、文件上传限制为5000MB,即限制SQLite数据库上传大小;
2、备份数据库和导入数据库前端页面状态显示,备份页面增加数据库文件大小;
3、支持当前SQLite数据库文件大小显示;
4、优化监控策略规则列表使用行内展开详情查看规则;
5、优化 dashboard 支持显示在线或离线状态显示;
6、优化 API脚本 列表中,可以通过提示方式查看完整的API脚本预览;
7、网络接口类型显示,支持Ethernet,Bridge,VLAN,MacVLAN,VETH,PPPoE拨号和Wireguard;
8、增加路由表显示,根据routing-table分组显示,每表目前仅显示10条路由。Shallow API v0.0.7beta23(下载):
1、增加监控策略触发次数 - 允许在触发多少次后在执行通知策略;
2、增加监控策略显示执行次数 - 能看到执行通知策略;
3、设备状态查看的UI - 让状态页面更紧凑;
4、增加网络接口图标 - 能看到各种网络接口连接的状态,以太网接口的速率。Shallow API v0.0.7beta22(下载):
1、新增策略管理包括:
* 监控策略 - 监控策略用于对指定RouterOS设备创建监控策略,当前支持系统信息如:CPU使用率、内存使用率、硬盘使用率、PPP在线数、DHCP客户端在线数、ARP连接数、Wi-Fi客户端连接数、NAT会话连接数、CPU温度和主板温度监控。网络接口数据如:网络接口的Tx/Rx 速率,Tx/R Bytes统计,协商速率状态、连接状态link-ok/no-link等,然后选择调用通知策略。
* 通知策略 - 通知策略可以创建email,Webhook、API脚本和日志记录操作
* Webhook - 创建Webhook通知,当前支持企业微信和钉钉
* API命令 - 将RouterOS的CLI命令行转换为API命令发送给RouterOS,不支持RouterOS Script脚本;
* 计划任务 - 设置定时的计划任务,执行API脚本命令;
2、新增设备分组 - 支持对RouterOS设备分组/区域管理,根据不同区域运行API命令脚本;
3、系统新增系统设置 - 主要新增smtp服务器设置,以及RouterOS设备连接和断开通知功能 ;
4、优化Web页面UI。