智能家庭网关软探针与监控平台的接口协议征求意见版.docx

1、智能家庭网关软探针与监控平台的接口协议征求意见版智能家庭网关软探针与监控平台的接口协议征求意见版2. 范围本协议规定了中国移动智能家庭网关软探针与软探针监控 平台之间的接口协议， 主要供智能家庭网关软探针和软探针监控平台 开发人员使用。3. 规范性引用文件下列文件中的条款通过本标准的引用而成为本 标准的条款。凡是标注日期的引用文件，其随后所有的修改单（不包括勘误的 内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议 的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。 序号标准编号标准名称发布单位 1 智能网关软探针中间件数据 定义规范中国移动通信

2、集团公司 2 中国移动智能家庭网关技术 规范中国移动通信集团公司 4. 术语、定义和缩略语下列术语、定 义和缩略语适用于本标准词语解释 DPI 深度报文检测技术 NAT NetworkAddress Translation 网络地址转换 NTP Network Time Protocol 网络时间协议 OLT OpticalLine Terminal 光线路终端 ONU OpticalNetwork Unit 光网络单元 OUI OrganizationallyUnique Identifiers 组织唯一标识 PPPoE PPPover Ether 以太网上传送 PPP 协议 QB- - -

3、 3QoS Qualityof Service 服务质量 RAM RandomAess Memo随ry 机存储器 SNMP SimpleNetwork ManagementProtocol 简单网络管理协议 SNTP SimpleNetworkTimeProtocol 简单网络时间协议 SOAP SimpleObjectAessProtocol 简单对象访问协议 SSID ServiceSet Identifier 服务 集标志符 TCP TransmissionControl Protocol 传输控制协议 TS TransportStream 传输流 UDP UserDatagram Pr

4、otocol 用户数据报协 议 URL UniformResource Locator 统一资源定位格式 USB UniversalSerial Bus 通用串行总线 VLAN VirtualLocal Area Network 虚拟局域网 WANW ideArea Network 广域网 WLANW irelessLAN 无线局域网 LAN LocalAreaNetwork 局域网 5. 智能家庭网关软探针与 监控平台接口定义 5.1. 接口功能描述智能家庭网关软探针通过 OSGI API（建议增加到缩略语表中）采集网关信息以及分析通过网关的数 据包信息，进行预处理生成上报数据。根据按触发上

5、报的不同的条件，软探针与软探针监控平台的接口 可分为表 5-1 上报接口类型上报类型功能描述开机上报上报网关的 基本信息， 状态信息， 下挂设备信息和智能家庭网关软探针的版本信 息；软探针监控平台返回相应的配置参数。周期上报上报周期内网关运行的参数；上报周期内网页浏览，下 载，即时通讯， 游戏等业务参数实时上报软探针监控平台下发探测指 令，软探针执行指令，并上报结果，如 Ping 、Tracroute 等告警上报 触发 TCP连接超时， DNS解析超时等告警，软探针将实时上传告警信 息网络探测软探针监控平台可根据需要向特定网关下发网络探测任 务，通过 Ping 或 Traceroute 检验网

6、络质量 5.2. 接口结构描述智能 家庭网关软探针与软探针监控平台的接口分布如下图 QB- - 4图5-1 智能家庭网关软探针与软探针监控平台的接口示意图 5.3. 接口协议说明智能家庭网关软探针通过等应用层协议实 现智能家庭网关软探针与软探针监控平台之间的远程访问； 本协议采 用 TCP，智能家庭网关软探针作为 client 向软探针监控平台发起 TCP 连接，监控平台响应后，即可关闭连接。5.3.1.请求发起数据传输消息由智能家庭网关软探针向软探针监 控平台发起访问请求，消息格式如下 Request URI 默认为“ / ”Host 软探针监控平台的域名及端口 Content-Type a

7、pplication/JSON Content-Length 表明了消息体长度； User-Agent 表明了客户端的信 息； POST/1.1Host:Content-Type:Content-Length:User-Agent:Date:Ae pt:Referrer:QB- - - 5Date 发起请求的日期、时 间 Aept 终端可以接收的响应消息的媒体类型消息体中包含一个 JSON 文档，详细数据格式请参考具体接口。5.3.2.请求返回数据接收消息由软探针监控平台向智能家庭网关 软探针返回数据请求结果，消息格式如下 Server 服务器软件信息 Content-Typeapplicat

8、ion/JSON Content-Length 消息体长度消息体 中包含一个 JSON文档，详细数据格式请参考具体接口。5.3.3.FTP 文件上传智能家庭网关软探针接收到开机上报请求的 返回结果后，软探针定期采集数据，保存到文件里面，并以 FTP方式 向监控平台发送数据。软探针可根据数据量大小和实时策略选择通过 FTP 协议传输数据。5.3.4.接口 JSON数据协议定义该定义为应用层协议， 和具体采用 的编码方式无关。为了提供服务器和机顶盒之间的交互速度，决定采用相对简单的 交互方式，采用一次交互流程进行交互。目前选择的编码方式是 JSON， Bean的数据组织格式为 “beanNam”e

9、 : “para1”:”value1 ”,”para2”,”value2”List ofString 的数据格式为“ listName ”: “value1 ”, ” value2 ”S/1.1200OK Server:Content-Type:Content-Length:Date:Expires:QB- - - 6List ofBean 的数据格式为“listName ”: “para1”: ” value1 ”, ”para2 ”: ”value2 ”, “ para1 ”: ”value1 ”, ”para2 ”: ” value2 ” 目前，后台端采用标准的 JSON解析库来解析数据

10、；机顶 盒端通过字符串匹配的方式来解析数据。6. 开机上报接口在智能家庭网关启动时，智能家庭网关软探针向 软探针监控平台发送数据，完成注册过程，和监控平台建立连接；同 时触发监控平台下发采集和周期上报数据的配置。请求 URL:s:/xxx:port/rest/cm_softprobe/home_gateway/bootmessage 6.1. 开机上报请求开机上报请求的消息体中包含一个 JSON文档，具 体信息如下 Nullable 类型含义 eventType N Bean事件类型 eventCode NInt 事件号 subEvent YInt 子事件号（这里无效） timeOffset

11、YInt 距离该条记录正确上报时间点的时间偏移量，正常上报为 0，上报由于其他时间导致延迟 1 分钟，上报值为 60，单位为秒 UserInfo usernameN String 用户名 password N String 密码，基于 S 连接， 可以不加密 deviceInfo N Bean 设备信息 deviceId N String 终端序 列号（即 HGU SN）manufacturer N String 网关厂家 cpu N String 网 关 CPU型号 hardwareVersion N String 网关硬件版本号 firmwareVersion NString 网关固件版本

12、 model NString 网关型号 mac NString 网关 MAC地址 wifiInfo NString 支持的 WIFI 信息 SSIDNString SSID 编号 SSIDname NString SSID 名字 SSIDMAC NString SSIDMAC地址 QB- - - 7SSIDEnable NString 使能 状态 SSIDAdvertisement NString 是否广播 SSIDStandard NString 标准，取值为 11n/11ac/11bg/11bgn/11gn/11a/11na SSIDEncryptionModeNString 加密模式，取

13、值为 OPEN WEP,WPAPSK,WPAPSK2,MIXED-WPAPSK2lanIP NString LA地N址IP wanIP NString WANIP 地址 nfcSupport Y String 是否支持 NFC，” Yes”, ”NO” flashSize NString 设备 flash 大小 ram_size NString 设备 ram 大小 dpiVersionInfo NBean 参数 version NString 软探针 中间件版本号 interfaceVersion NString 接口协议版本号 deviceStatus Y Bean 网关运行状态 bootT

14、ime NString 开机时间 runingTime NString 运行时间 CPU NString CPU占用率 RAM NString 内存占用率 lan1ConnectStatus NString LAN1 的连接状 态 ,tatus:string 状态取值 CONNECTING CONNECTEDDISCONNECTEDUNCONFIGUREDlan2ConnectStatus NString LAN2的连接状态，取值 同 LAN1lan3ConnectStatus NString LAN3 的连接状态，取值同 LAN1lan4ConnectStatus NString LAN4的

15、连接状态，取值同 LAN1WAN NString WAN的连接状态，取值同 LAN1WIFI NString WIFI 的连接状 态 PPPOEDial NString PPPOE拨号状态 PPPOEError NString PPPOE 拨号失败原因 PPPOEStatus NString PPPOE的连接状态 PONTXPower NInt PON口的发射光功率 （单位 0.1 微瓦）PONRXPower NInt PON口的 接收光功率 （单位 0.1 微瓦）WLANNeighbor Y Bean获取 WLAN频段邻 居信息 number YInt 邻居 WIFI 设备数量 radioI

16、nfo YBean 邻居 WLAN 频段信息 radioType Y String2.4G ，5G SSIDNameYBeanWIF信I 号名 称 Mac YBean邻居 WIFI 设备 MACs ubDeviceInfoYBean 网关下挂设备 信息 QB- - - 8subDeviceNumber Y String 下挂设 备数量 deviceInfo YBean设备信息 deviceType Y String 设备类型， 手机 /PC/PAD deviceNameY String 设备别名 manufacture Y String 设备厂家 model Y String 设备型号 WLA

17、NRadioType YString2.4G， 5G WLANRadioPowerYStringWLA发N 射功率百分比调用参数实例 eventType:eventCode:1,subEvent:0,timeOffset: 0,deviceInfo:deviceId:0025E4C2D1FE5F9C,manufactur er:ABCD,Model:HS3025,MAC:E4C2D1FE5F9C,WANIP:2 02.8.8.8,CPU:HILSI0038,wifiinfo:SSID:1,SSIDna me:home01,SSIDMAC:E4C2D1FE5F9C,SSIDEnable:TRUE

18、, SSIDStandard:11a/11b/11g,SSID:5,SSIDname:home02 ,SSIDMAC:E4C2D1FE5F9C,SSIDEnable:TRUE,SSIDStandard:11n/11ac ，deviceStatus:bootTime:01:23:36,CPU:10%, ,dpiVersionInfo:version:1.0.3, 6.2. 开机上报响应收到智能家庭网关软探针开机上报报文后， 软探针监控平台发送开机 上报响应报文，把需要智能家庭网关软探针采集和定期上报的信息配 置下来。开机上报响应的消息体中包含一个 JSON文档，具体信息如下名称 单位 Nulla

19、ble 类型含义 result NInt 执行结果 timeStamp NString 服务器的当前相对时间( 1970-01-0100:00:00 )UserInfo YString 可选的修改用户密码能力。username YString 用户名，不能修改 password YString 修改后 的密码，基于 S 连接，可以不加密 configParameterList 需要采集的 数据定义 QB- - - 9file_ftpserver YString 文件方式上报服务器 IP 地址 file_uploadpath YString 文件方式上报采集结果文件保存根路径 ftpuserna

20、me YString FTP/SFTP 用户，加密 传输 ftpuserpwd YString FTP/SFTP 密码，加密传输 userlabel NString 用户标识，可以考虑加密传输存储 DeviceRunningInfoData reportmode YString 文件方式上报，还是消息上报 msgreportinterval YString 消息上报的时间间隔，如 10 分钟上报 一次 sampleinterval YString 采集周期，单位秒，如 30 秒一次 WAN1StatusY String WAN1上行口状态 WAN1TypeY String WAN1类型， 宽带

21、还是语音等 WAN1ConnectTypeY StringWAN1连接类型，如下值之IP_Routed/IP_Bridged/PPPoE_Bridged/PPPoE_RoutedWAN2StatusY String WAN2上行口状态 WAN2TypeY String WAN2类型， 宽带还是语音等 WAN2ConnectType YString WAN2连接类型 WAN3StatusY String WAN3上行口状态 WAN3TypeY String WAN3类型， 宽带还是语音等 WAN3ConnectType YString WAN3连接类型 CPURate%YString CPU利用

22、率 MemRate%YString内存利用率 LAN1ConnectStatus YString LAN1 口连接状态 LAN2ConnectStatus YString LAN2 口连接状态 SSID1ConnectStatus YString SSID1 连接 状态 SSID5ConnectStatus YString SSID2 连接状态可以自定义 扩充采集参数 TrafficData 网关数据流量信息 reportmode YString 文件方式上报，还是消息上报 filename YString 文件上报的文件名 字 filereporttime YString 文件上报的时间 s

23、ampleinterval YString 采集周期，单位秒，如30秒一次 QB- - - 10averTxRate NString 网关上行带宽周期均值 averRxRate NString 网关下行带宽周期均值 maxTxRate NString 网关上行带宽周期最大 maxRxRate NString 网关下行带宽周期最大可以自定义扩充采集 参数 subDevice reportmodeYString 文件方式上报，还是消息上报 filename YString 文件上报的文件名字 filereporttime YString 文件上报的时间 sampleinterval YString

24、 采集周期，单位秒，如 30 秒 一次 subDeviceList connectmodeYString 接入方式， LAN,WIFI,ZIGBEE等 port YString LAN 端口， SSID编号等 subDeviceMAC YString 设备 MAC地址 subDeviceType YString 设备 类型 subDeviceManufacturer YString 设备厂商 subDeviceBandwidth YString 设备带宽可以自定义扩充采集参数可以自定义扩充 采集数据集合 ServiceTrafficMonitor 业务流量监控 reportmodeYStrin

25、g 消息上报 msgreportinterval YString 消息上报 的时间间隔，如 10 分钟上报一次 sampleinterval YString 采集周期， 单位秒，如 30秒一次 SIP YString 源IP 地址SPort YString 源端口 DestIP YString 目标 IP 地址 DestPort YString 目标端口 Protocal YString 传输协议 DestDNS YString 服务域名 Traffic YString 流量 信息 DNSDealy YString 域名解析时间 Delay YString 时延 VisitNumber YSt

26、ring 访问数量 Y StringAlarmThresholdList 告 警门限设置 CPURateThreshold YString CPU 利用率 QB- - - 11MemRateThreshold YString 内存利用率可以自定义 扩充告警门限值返回消息数据样例 result:0,timeStamp:xx-03-0911-27-16,configParamet erList:file_uploadtime:00:00:00,/ 上传时间，时分秒格式 file_ftpserver:172.16.34.200,/ 服务器 IP 地址 file_uploadpath:cmprobe/

27、hgu,/ 服务器文件保存地址 ftpusername:cmprobe,/ftp 用户名称 ftpuserpwd:Changeme_123,/ftp 用户密码 userlabel:CMCCHGU1256,/ 用户标签，可以传递用户账号信息 DeviceRunningInfoData:reportmode:MESSAGE,/ 上报方式， 消息上报 msgreportinterval:600,/ 上报间隔，单位秒sampleinterval:60,/ 采样间隔，单位秒 paraList:WAN1Status,/WAN1 口状态 WAN1Type,/WAN1类型，宽 带上网 WAN2Status,/

28、WAN2口状态 WAN2Type,/WAN2类型， IPTV WAN3Status,/WAN3口状态 WAN3Type,/WAN3类型，语音 VAGStatus,CPURate,MemRate,LAN1ConnectStatus,LAN2ConnectStat us,SSID1ConnectStatus,SSID5ConnectStatus,TrafficData: reportmode:FILE,/ 上报方式，文件上报filename:TrafficData-YYMMDDHHMMSS.txt,/ 上报间隔，单位秒 filereporttime:00:00:00,/ 上报时间，文件方式没有零点

29、上传 sampleinterval:120,/ 采样间隔，单位秒 paraList:CPURate,MemRate,Bandwidth,BandwidthRate, ,subDevice:reportmode:FILE,/ 上报方式，文件上报 filename:subDevice-YYMMDDHHMMSS.txt,/ 上报间隔，单位秒 filereporttime:00:00:00,/ 上报时间，文件方式没有零点上传 sampleinterval:3600,/ 采样间隔，单位秒 QB- - - 12paraList:connectmode,port,subDeviceMAC,subDevice

30、Type,s ubDeviceManufacturer,subDeviceBandwidth, ,ServiceTrafficMonitor:reportmode:MESSAGE,/ 上报 方式，消息上报 msgreportinterval:600,/ 上报间隔，单位秒 sampleinterval:60,/ 采样间隔，单位秒 paraList:SIP ， / 源IP地址 SPort ，/ 源端口 DestIP ，/ 目标 IP地址 DestPort,/ 目 标端口 Protocal,/ 传输协议 DestDNS,/ 服务域名信息 Traffic,/ 流量信息 DNSDelay,/ 域名解析时

31、间 Delay,/ 时延 VisitNumber/ 访 问次 数AlarmThresholdList:CPURateThreshold,MemRateThreshold ,WAN1DiscardThreshold,WAN2DiscardThreshold,7. 周期上报接口 在智能家庭网关软探针接收到开机上报请求的返回结果后， 软探针定 期采集数据，并向监控平台发送数据。周期上报 URLs:/xxx:port/rest/cm_softprobe/home_gateway/periodicmess age7.1. 周期上报请求周期上报请求的消息体中包含一个 JSON文档， 具体信息如下 Nullable 类型含义 eventType NBean 事件类型 eventCode NInt 事件号 subEvent YInt 子事件号 actualTime YInt 事件发生的服务器时间，单位为毫秒，与 boot 返回字段 timeStamp 格式一致 deviceInfo NBean设备信息 deviceId NString 终端序列号 （即HGU SN）Mac NString终