蓝海卓越AC管理接口通信规范V1.4.1

蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有蓝海卓越AC管理接口通信规范V1.4.1作者：李杰审核：刘岗初稿：2014年11月11日修订：2015年4月18日蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有日期版本修订说明修订人2014-11-101.0初始版本李杰2014-11-171.11.修改3.2请求主体getonline为getap2.修正3.7返回errorCode为errorcode李杰2014-11-181.2增加(3.7)portal设置、(3.8)获取Portal设置nasip参数，Portal需要该参数选择对接的NAS李杰2015-01-181.3新增AP配置WiFi接口以适应多SSID李杰2015-04-151.4对提交WTP配置、增加WiFi、删除WiFi配置增加opt字段，该字段表示该操作是否立即应用李杰2015-4-181.4.1格式调整，部分描述文字调整刘岗蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有目录一、术语和定义...............................................................................................................................4二、概述.........................................................................................................................................5三、协议.........................................................................................................................................63.1获取AP列表.....................................................................................................................63.2获取指定AP信息.............................................................................................................83.3获取指定AP用户信息...................................................................................................123.4重启指定AP设备...........................................................................................................153.5强制用户下线.................................................................................................................163.6提交AP配置...................................................................................................................173.7添加WiFi配置...............................................................................................................203.8删除WiFi配置...............................................................................................................223.9提交Portal配置...........................................................................................................233.10获取Portal设置.........................................................................................................253.11提交Radius设置.........................................................................................................273.12获取Radius设置.........................................................................................................293.13获取AC系统状态.........................................................................................................30四、相关代码定义.........................................................................................................................324.1802.11无线类型代码定义............................................................................................324.2操作系统代码定义.........................................................................................................334.3浏览器代码定义.............................................................................................................34蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有一、术语和定义AC——无线接入控制器AC管理系统——这是一套WEB程序，使用本协议规定的HTTP格式和AC的管理WEB服务器进行交互。从而完成对AC配置的功能。AP——无线访问接入点Portal——门户业务Radius——RADIUS：RemoteAuthenticationDialInUserService，远程用户拨号认证系统由RFC2865，RFC2866定义。蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有二、概述蓝海卓越AC系统通过一个HTTP服务器对外提供配置接口。AC提供一个WEB服务器接口，AC管理系统通过GET或者POST提交给AC，AC端返回JSON。AC管理系统和AC之间使用共享密钥验证作为安全验证基础。该协议所有的请求均由AC管理系统发起，AC被动响应请求。每次请求如下图所示。ACWEB管AC定时器请求响应蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有三、协议3.1获取AP列表请求主体：getregaplist?ver=1.1&opt=1&sig=x参数说明：ver-协议版本，当前版本为1.1opt-获取AP分类0-所有AP1-在线AP列表2-离线AP列表sig-sig为请求签名，计算方法为MD5(“getregaplist”+”ver”+ver+”opt”+”1”+secret)其中双引号表示字符串，无双引号的取其变量值的字符串。secret为AC配置的WEB管理授权共享密钥字符串蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有返回格式：{code:%d,objn:%d,obja:[{apid:%s,firm:%s,ssid:%s,usrn:%d,life:%d,note:%s},{…},…]}返回说明：code-错误代码0-成功1-出错蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有2-没有APobjn-本次返回的AP数量obja-AP列表信息数组，包含objn个AP的概要信息对象；apid-AP的唯一标识符，比如APMAC或者APUUID等能够唯一表示该AP的字符串。长度不能超过36字节firm-固件版本，在线AP有效ssid-当前AP无线名称，最大长度不能超过32字节usrn-用户数量life-在线时长note-AP的备注描述，比如AP别名、AP安装位置等描述信息。长度不能超过128字节3.2获取指定AP信息请求主体：gettheap?ver=1.1&apid=x&sig=x参数说明：ver-协议版本，当前版本为1.1；apid-AP的唯一标识符，比如APMAC或者APUUID等能够唯一表示该AP的字符串。长度不能超过36字节sig-sig为请求签名，计算方法为MD5(“gettheap”+”ver”+ver+”apid”+apid+secret)蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有其中双引号表示字符串，无双引号的取其变量值的字符串。secret为AC配置的WEB管理授权共享密钥字符串。返回格式：{code:%d,apid:%s,firm:%s,note:%s,state:%d,cpu:%d,mem:%d,life:%ld,usrn:%d,echo:%d,idle:%d,WiFi:[{ssid:%s,radio:%d,suppssid:%d,channel:%d,power:%d,蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有},{…},…]traffic:[{ifname:%s,in:%d,out:%d},{…},…]}返回说明：code-错误代码0-成功1-出错apid-AP的唯一标识符，比如APMAC或者APUUID等能够唯一表示该AP的字符串。长度不能超过36字节firm-固件版本，在线AP有效蓝海卓越AC管理接口通信规范成都星锐蓝海网络科技有限公司版权所有note-该AP的描述，如AP别名、AP安装位置等描述信息。长度不能超过128字节state-AP状态0-离线1-在线cpu-AP的CPU使用率，0至100的整数mem-AP内存使用率，0至100的整数life-AP在线时长，正整数，单位秒usrn-该AP当前用户数量，正整数radio-AP当前无线类型，正整数，具体值参考4.1节802.11无线类型代码定义suppssid-是否隐藏SSID0-不隐藏1-隐藏channel-AP无线频道，大陆地区不能超过14power-AP无线发射功率，单位毫瓦(mW)echo-AP与AC之间的心跳检测时间间隔，单位秒idle-用户保活时间，单位秒ssid-当前AP无线名称，最大长度不能超过32字节traffic-AP接口流量速度统计。其中ifname为接口名字；in为进入流量速度（单位bps）；out为出去流量速度（单位bps）蓝海卓越AC管理接口通信