查看“API”的源代码

{{DISPLAYTITLE:WFilter NGF的API接口}}

= 概述 =

WFilter NGF的API，主要提供如下功能：
* 系统状态的监控
* 带宽、客户端状态的监控
* 行为管理

具体接口列表如下：

= 系统状态 =
== 获取网络接口列表 ==
* 命令：get_network_interfaces
* 参数：无
* 返回格式：JSON
* 返回内容格式
== 获取网络接口状态 ==
* 命令：get_network_status
* 参数：无
* 返回格式：JSON
* 返回内容格式

= 带宽、客户端状态 =
== 获取一段时间内的总带宽 ==
* 命令：list_bandwidth
* 参数：时长（秒）
* 返回格式：JSON
* 返回内容格式
== 获取在线IP列表 ==
* 命令：list_online_users
* 参数：记录条数（最大1000），搜索条件。
* 返回格式：JSON
* 返回内容格式
== 获取IP的所有在线连接 ==
* 命令：list_online_connections
* 参数：IP
* 返回格式：JSON
* 返回内容格式

= 参数获取 =
== 获取用户组列表 ==
* 命令：list_group
* 参数：无
* 返回格式：JSON
* 返回内容格式
== 获取本地账号列表 ==
* 命令：list_account
* 参数：无
* 返回格式：JSON
* 返回内容格式

= 客户端行为管理 =
== 断开连接（踢用户下线），解封 ==
* 命令：kill_connection
* 参数：
** port ： 该连接的本地端口，0 -- 所有端口
** type ： "ALL"--所有协议，"RESET"--重置，"REMOVE"--全部放行，其他--协议名称
** minutes ： N分钟（时长）
** message ： 推送的消息（urlencode）
* 返回：TRUE or FALSE
== 把IP加入到虚拟组 ==
* 命令：add_virtual_group
* 参数：
** groupid：组ID
** ip：客户机IP地址
** minutes：加入的时长（分钟）
* 返回：TRUE or FALSE
== 把IP从虚拟组中移出 ==
* 命令：rm_virtual_group
* 参数：IP
* 返回：TRUE or FALSE

= SDK下载 =
== php ==
[[Media:WFilterNGF_SDK_php.zip]]