“API”的版本间的差异
来自WFilter上网行为管理系统文档和指南
（→配置的添加、修改和删除） |
|||
| （未显示同一用户的8个中间版本） | |||
| 第64行： | 第64行： | ||
* 参数： | * 参数： | ||
** groupid：组ID | ** groupid：组ID | ||
| − | ** | + | ** ip：客户机IP地址或者用户名。（用户名格式：“CN=用户名,OU=group ID,DC=wflocal”，需要urlencode。如：CN=test,DC=wflocal） |
** minutes：加入的时长（分钟） | ** minutes：加入的时长（分钟） | ||
* 返回：TRUE or FALSE | * 返回：TRUE or FALSE | ||
| − | == | + | |
| + | == 列出虚拟组中的用户和IP == | ||
| + | * 命令：list_virtual_group | ||
| + | * 参数：groupid | ||
| + | * 返回：IP、用户列表 | ||
| + | |||
| + | == 从虚拟组中移出 == | ||
* 命令：rm_virtual_group | * 命令：rm_virtual_group | ||
| − | * | + | * 参数：IP或者用户名 |
* 返回：TRUE or FALSE | * 返回：TRUE or FALSE | ||
| 第116行： | 第122行： | ||
* 命令：config_apply | * 命令：config_apply | ||
* 参数：无 | * 参数：无 | ||
| + | |||
| + | == 配置文件列表和格式 == | ||
| + | * 请参考：[[ConfigFiles|配置文件列表和格式]] | ||
= 查询数据库 = | = 查询数据库 = | ||
| 第122行： | 第131行： | ||
** 数据库名字，如：report.db | ** 数据库名字，如：report.db | ||
** 查询SQL（urlencode），如：select count(*) from webreport | ** 查询SQL（urlencode），如：select count(*) from webreport | ||
| + | * 数据库结构请参考：[[Database|WFilter NGF的数据库结构]] | ||
= SDK下载 = | = SDK下载 = | ||
== php == | == php == | ||
| − | 点击下载：[[Media:WFilterNGF_SDK_php.zip|php版本的SDK下载]] | + | 点击下载：[[Media:WFilterNGF_SDK_php.zip|php版本的SDK下载]]（最新更新日期：2022-08-05） |
= 相关链接 = | = 相关链接 = | ||
* [http://www.imfirewall.com/blog/post/334.html WFilter NGF的API调用举例] | * [http://www.imfirewall.com/blog/post/334.html WFilter NGF的API调用举例] | ||
* [http://www.imfirewall.com/blog/post/477.html 如何通过API获取WFilter NGF的统计报表？] | * [http://www.imfirewall.com/blog/post/477.html 如何通过API获取WFilter NGF的统计报表？] | ||
| + | * [http://www.imfirewall.com/blog/post/527.html 如何利用API来读取WFilter NGF的后台数据库？] | ||
2023年9月27日 (三) 16:34的最新版本
1 概述
WFilter NGF的API，主要提供如下功能：
- 系统状态的监控
- 带宽、客户端状态的监控
- 行为管理
具体接口列表如下：
2 系统状态
2.1 获取网络接口列表
- 命令：get_network_interfaces
- 参数：无
- 返回格式：JSON
- 返回内容格式
2.2 获取网络接口状态
- 命令：get_network_status
- 参数：无
- 返回格式：JSON
- 返回内容格式
3 带宽、客户端状态
3.1 获取一段时间内的总带宽
- 命令：list_bandwidth
- 参数：时长（秒）
- 返回格式：JSON
- 返回内容格式
3.2 获取在线IP列表
- 命令：list_online_users
- 参数：记录条数（最大1000），搜索条件。
- 返回格式：JSON
- 返回内容格式
3.3 获取IP的所有在线连接
- 命令：list_online_connections
- 参数：IP
- 返回格式：JSON
- 返回内容格式
4 参数获取
4.1 获取用户组列表
- 命令：list_group
- 参数：无
- 返回格式：JSON
- 返回内容格式
4.2 获取本地账号列表
- 命令：list_account
- 参数：无
- 返回格式：JSON
- 返回内容格式
5 客户端行为管理
5.1 断开连接（踢用户下线），解封
- 命令：kill_connection
- 参数：
- port ： 该连接的本地端口，0 -- 所有端口
- type ： "ALL"--所有协议，"RESET"--重置，"REMOVE"--全部放行，其他--协议名称
- minutes ： N分钟（时长）
- message ： 推送的消息（urlencode）
- 返回：TRUE or FALSE
5.2 把IP加入到虚拟组
- 命令：add_virtual_group
- 参数：
- groupid：组ID
- ip：客户机IP地址或者用户名。（用户名格式：“CN=用户名,OU=group ID,DC=wflocal”，需要urlencode。如：CN=test,DC=wflocal）
- minutes：加入的时长（分钟）
- 返回：TRUE or FALSE
5.3 列出虚拟组中的用户和IP
- 命令：list_virtual_group
- 参数：groupid
- 返回：IP、用户列表
5.4 从虚拟组中移出
- 命令：rm_virtual_group
- 参数：IP或者用户名
- 返回：TRUE or FALSE
5.5 关联用户名到IP
- 命令：add_user
- 参数：
- ip: 要关联用户名的IP地址
- user: 用户名(urlencode)
- from: 来自于（比如：webauth, pppoe）
- expire: 多少时间后过期（秒）
- 返回：TRUE or FALSE
5.6 取消用户名关联
- 命令：rm_user
- 参数：ip或者用户名(urlencode)
- 返回：TRUE or FALSE
6 配置的添加、修改和删除
6.1 获取配置文件
- 命令：config_load
- 参数cfgname：配置文件名
- 返回：json格式的配置文件
6.2 添加配置
- 命令：config_add
- 参数：
- cfgname：配置文件名
- type：配置类型
- name：配置段名称
- values：JSON格式的配置段内容
6.3 修改配置
- 命令：config_set
- 参数：
- cfgname：配置文件名
- section：配置段名称
- values：JSON格式的配置段内容
6.4 删除配置
- 命令：config_del
- 参数：
- cfgname：配置文件名
- section：要删除的配置段名称
6.5 应用新配置
- 命令：config_apply
- 参数：无
6.6 配置文件列表和格式
- 请参考：配置文件列表和格式
7 查询数据库
- 命令：query_db
- 参数：
- 数据库名字，如：report.db
- 查询SQL（urlencode），如：select count(*) from webreport
- 数据库结构请参考：WFilter NGF的数据库结构
8 SDK下载
8.1 php
点击下载：php版本的SDK下载（最新更新日期：2022-08-05）
