智能家庭网关软探针与监控平台的接口协议征求意见版.docx
《智能家庭网关软探针与监控平台的接口协议征求意见版.docx》由会员分享，可在线阅读，更多相关《智能家庭网关软探针与监控平台的接口协议征求意见版.docx（13页珍藏版）》请在冰点文库上搜索。
智能家庭网关软探针与监控平台的接口协议征求意见版
智能家庭网关软探针与监控平台的接口协议征求意见版
2.范围本协议规定了中国移动智能家庭网关软探针与软探针监控平台之间的接口协议，主要供智能家庭网关软探针和软探针监控平台开发人员使用。
3.规范性引用文件下列文件中的条款通过本标准的引用而成为本标准的条款。
凡是标注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件，其最新版本适用于本标准。
序号标准编号标准名称发布单位[1]《智能网关软探针中间件数据定义规范》中国移动通信集团公司[2]《中国移动智能家庭网关技术规范》中国移动通信集团公司4.术语、定义和缩略语下列术语、定义和缩略语适用于本标准词语解释DPI深度报文检测技术NATNetworkAddressTranslation网络地址转换NTPNetworkTimeProtocol网络时间协议OLTOpticalLineTerminal光线路终端ONUOpticalNetworkUnit光网络单元OUIOrganizationallyUniqueIdentifiers组织唯一标识PPPoEPPPoverEther以太网上传送PPP协议QB-╳╳-╳╳╳-╳╳╳╳3QoSQualityofService服务质量RAMRandomAessMemo随ry机存储器SNMPSimpleNetworkManagementProtocol简单网络管理协议SNTPSimpleNetworkTimeProtocol简单网络时间协议SOAPSimpleObject
AessProtocol简单对象访问协议SSIDServiceSetIdentifier服务集标志符TCPTransmissionControlProtocol传输控制协议TSTransportStream传输流UDPUserDatagramProtocol用户数据报协议URLUniformResourceLocator统一资源定位格式USBUniversalSerialBus通用串行总线VLANVirtualLocalAreaNetwork虚拟局域网WANWideAreaNetwork广域网WLANWirelessLAN无线局域网LANLocalAreaNetwork局域网5.智能家庭网关软探针与监控平台接口定义5.1.接口功能描述智能家庭网关软探针通过OSGIAPI（建议增加到缩略语表中）采集网关信息以及分析通过网关的数据包信息，进行预处理生成上报数据。
根据按触发上报的不同的条件，软探针与软探针监控平台的接口可分为表5-1上报接口类型上报类型功能描述开机上报上报网关的基本信息，状态信息，下挂设备信息和智能家庭网关软探针的版本信息；软探针监控平台返回相应的配置参数。
周期上报上报周期内网关运行的参数；上报周期内网页浏览，下载，即时通讯，游戏等业务参数实时上报软探针监控平台下发探测指令，软探针执行指令，并上报结果，如Ping、Tracroute等告警上报触发TCP连接超时，DNS解析超时等告警，软探针将实时上传告警信息网络探测软探针监控平台可根据需要向特定网关下发网络探测任务，通过Ping或Traceroute检验网络质量5.2.接口结构描述智能家庭网关软探针与软探针监控平台的接口分布如下图QB-╳╳-╳╳╳-╳╳╳╳4图5-1智能家庭网关软探针与软探针监控平台的接口
示意图5.3.接口协议说明智能家庭网关软探针通过等应用层协议实现智能家庭网关软探针与软探针监控平台之间的远程访问；本协议采用TCP，智能家庭网关软探针作为client向软探针监控平台发起TCP连接，监控平台响应后，即可关闭连接。
5.3.1.请求发起数据传输消息由智能家庭网关软探针向软探针监控平台发起访问请求，消息格式如下RequestURI默认为“/”Host软探针监控平台的域名及端口Content-Typeapplication/JSONContent-Length表明了消息体长度；User-Agent表明了客户端的信息；POST/1.1Host:
Content-Type:
Content-Length:
User-Agent:
Date:
Aept:
Referrer:
QB-╳╳-╳╳╳-╳╳╳╳5Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型消息体中包含一个JSON文档，详细数据格式请参考具体接口。
5.3.2.请求返回数据接收消息由软探针监控平台向智能家庭网关软探针返回数据请求结果，消息格式如下Server服务器软件信息Content-Typeapplication/JSONContent-Length消息体长度消息体中包含一个JSON文档，详细数据格式请参考具体接口。
5.3.3.FTP文件上传智能家庭网关软探针接收到开机上报请求的返回结果后，软探针定期采集数据，保存到文件里面，并以FTP方式向监控平台发送数据。
软探针可根据数据量大小和实时策略选择通过FTP协议传输数据。
5.3.4.接口JSON数据协议定义该定义为应用层协议，和具体采用的编码方式无关。
为了提供服务器和机顶盒之间的交互速度，决定采用相对简单的交互方式，采用一次交互流程进行交互。
目前选择的编码方式是JSON，Bean的数据组织格式为“beanNam”e:
{“para1”:
”value1”,”para2”,”value2”}ListofString的数据格式为“listName”:
[“value1”,”value2”]S/1.1200OKServer:
Content-Type:
Content-Length:
Date:
Expires:
QB-╳╳-╳
╳╳-╳╳╳╳6ListofBean的数据格式为“listName”:
[{“para1”:
”value1”,”para2”:
”value2”},{“para1”:
”value1”,”para2”:
”value2”}]目前，后台端采用标准的JSON解析库来解析数据；机顶盒端通过字符串匹配的方式来解析数据。
6.开机上报接口在智能家庭网关启动时，智能家庭网关软探针向软探针监控平台发送数据，完成注册过程，和监控平台建立连接；同时触发监控平台下发采集和周期上报数据的配置。
请求URL:
s:
//xxx:
port/rest/cm_softprobe/home_gateway/bootmessage6.1.开机上报请求开机上报请求的消息体中包含一个JSON文档，具体信息如下Nullable类型含义eventTypeNBean事件类型eventCodeNInt事件号subEventYInt子事件号（这里无效）timeOffsetYInt距离该条记录正确上报时间点的时间偏移量，正常上报为0，上报由
于其他时间导致延迟1分钟，上报值为60，单位为秒UserInfousernameNString用户名passwordNString密码，基于S连接，可以不加密deviceInfoNBean设备信息deviceIdNString终端序列号（即HGUSN）manufacturerNString网关厂家cpuNString网关CPU型号hardwareVersionNString网关硬件版本号firmwareVersionNString网关固件版本modelNString网关型号macNString网关MAC地址wifiInfoNString支持的WIFI信息SSID
NStringSSID编号SSIDnameNStringSSID名字SSIDMACNStringSSIDMAC地址QB-╳╳-╳╳╳-╳╳╳╳7SSIDEnableNString使能状态SSIDAdvertisementNString是否广播SSIDStandardNString标准，取值为11n/11ac/11bg/11bgn/11gn/11a/11naSSIDEncryptionModeNString加密模式，取值为OPENWEP,WPAPSK,WPAPSK2,MIXED-WPAPSK2lanIPNStringLA地N址IPwanIPNStringWANIP地址nfcSupportYString是否支持NFC，”Yes”,”NO”flashSizeNString设备flash大小ram_sizeNString设备ram大小dpiVersionInfoNBean参数versionNString软探针中间件版本号interfaceVersionNString接口协议版本号deviceStatusYBean网关运行状态bootTimeNString开机时间runingTimeNString运行时间CPUNStringCPU占用率RAMNString内存占用率lan1ConnectStatusNStringLAN1的连接状态,tatus:
string状态取值CONNECTINGCONNECTEDDISCONNECTED
UNCONFIGUREDlan2ConnectStatusNStringLAN2的连接状态，取值同LAN1lan3ConnectStatusNStringLAN3的连接状态，取值同LAN1lan4ConnectStatusNStringLAN4的连接状态，取值同LAN1WANNStringWAN的连接状态，取值同LAN1WIFINStringWIFI的连接状态PPPOEDialNStringPPPOE拨号状态PPPOEErrorNStringPPPOE拨号失败原因PPPOEStatusNStringPPPOE的连接状态PONTXPowerNIntPON口的发射光功率（单位0.1微瓦）PONRXPowerNIntPON口的接收光功率（单位0.1微瓦）WLANNeighborYBean获取WLAN频段邻居信息numberYInt邻居WIFI设备数量radioInfoYBean邻居WLAN频段信息radioTypeYString2.4G，5GSSIDNameYBeanWIF信I号名称MacYBean邻居WIFI设备MACsubDeviceInfoYBean网关下挂设备信息QB-╳╳-╳╳╳-╳╳╳╳8subDeviceNumberYString下挂设备数量deviceInfoYBean设备信息deviceTypeYString设备类型，手机/PC/PADdeviceNameYString设备别名manufactureYString设备厂家modelYString设备型号WLANRadioTypeYString2.4G，5GWLANRadioPowerYStringWLA发N射功率百分比调用参数实例{"eventType":
{"eventCode":
"1","subEvent":
"0"},"timeOffset":
"0","deviceInfo":
{"deviceId":
"0025E4C2D1FE5F9C","manufacturer":
"ABCD","Model":
"HS3025","MAC":
"E4C2D1FE5F9C","WANIP":
"202.8.8.8","CPU":
"HILSI0038","wifiinfo":
[{"SSID":
"1","SSIDname":
"home01","SSIDMAC":
"E4C2D1FE5F9C","SSIDEnable":
"TRUE","SSIDStandard":
"11a/11b/11g"},{"SSID":
"5","SSIDname":
"home02","SSIDMAC":
"E4C2D1FE5F9C","SSIDEnable":
"TRUE","SSIDStandar
d":
"11n/11ac"}]}，
"deviceStatus":
{"bootTime":
"01:
23:
36","CPU":
"10%",},"
dpiVersionInfo":
{"version":
"1.0.3",}}6.2.开机上报响应
收到智能家庭网关软探针开机上报报文后，软探针监控平台发送开机上报响应报文，把需要智能家庭网关软探针采集和定期上报的信息配置下来。
开机上报响应的消息体中包含一个JSON文档，具体信息如下名称单位Nullable类型含义resultNInt执行结果timeStampNString服务器的当前相对时间（1970-01-0100:
00:
00）UserInfoYString可选的修改用户密码能力。
usernameYString用户名，不能修改passwordYString修改后的密码，基于S连接，可以不加密configParameterList需要采集的数据定义QB-╳╳-╳╳╳-╳╳╳╳9file_ftpserverYString文件
方式上报服务器IP地址file_uploadpathYString文件方式上报采
集结果文件保存根路径ftpusernameYStringFTP/SFTP用户，加密传输ftpuserpwdYStringFTP/SFTP密码，加密传输userlabelNString用户标识，可以考虑加密传输存储DeviceRunningInfoDatareportmodeYString文件方式上报，还是消息上报msgreportintervalYString消息上报的时间间隔，如10分钟上报一次sampleintervalYString采集周期，单位秒，如30秒一次WAN1StatusYStringWAN1上行口状态WAN1TypeYStringWAN1类型，宽带还是语音等WAN1ConnectTypeYStringWAN1连接类型，如下值之
IP_Routed/IP_Bridged/PPPoE_Bridged/PPPoE_Routed
WAN2StatusYStringWAN2上行口状态WAN2TypeYStringWAN2类型，宽带还是语音等WAN2ConnectTypeYStringWAN2连接类型WAN3StatusYStringWAN3上行口状态WAN3TypeYStringWAN3类型，宽带还是语音等WAN3ConnectTypeYStringWAN3连接类型CPURate%YStringCPU利用率MemRate%YString内存利用率LAN1ConnectStatusYStringLAN1口连接状态LAN2ConnectStatusYStringLAN2口连接状态SSID1ConnectStatusYStringSSID1连接状态SSID5ConnectStatusYStringSSID2连接状态⋯⋯可以自定义扩充采集参数TrafficData网关数据流量信息reportmodeYString文件方式上报，还是消息上报filenameYString文件上报的文件名字filereporttimeYString文件上报的时间sampleintervalYString采集周期，单位秒，如30秒一次QB-╳╳-╳╳╳-╳╳╳╳10averTxRateNString网关上行带宽周期均值averRxRateNString网关下行带宽周期均值maxTxRateNString网关上行带宽周期最大maxRxRateNString网关下行带宽周期最大⋯⋯可以自定义扩充采集参数subDevicereportmodeYString文件方式上报，还是消息上报filenameYString文件上报的文件名字filereporttimeYString文
件上报的时间sampleintervalYString采集周期，单位秒，如30秒一次subDeviceListconnectmodeYString接入方式，LAN,WIFI,ZIGBEE等portYStringLAN端口，SSID编号等subDeviceMACYString设备MAC地址subDeviceTypeYString设备类型subDeviceManufacturerYString设备厂商subDeviceBandwidthYString设备带宽⋯⋯可以自定义扩充采集参数⋯⋯可以自定义扩充采集数据集合ServiceTrafficMonitor业务流量监控reportmodeYString消息上报msgreportintervalYString消息上报的时间间隔，如10分钟上报一次sampleintervalYString采集周期，单位秒，如30秒一次SIPYString源IP地址SPortYString源端口DestIPYString目标IP地址DestPortYString目标端口ProtocalYString传输协议DestDNSYString服务域名TrafficYString流量信息DNSDealyYString域名解析时间DelayYString时延VisitNumberYString访问数量⋯⋯YStringAlarmThresholdList告警门限设置CPURateThresholdYStringCPU利用率QB-╳╳-╳╳╳-╳╳╳╳11MemRateThresholdYString内存利用率⋯⋯可以自定义扩充告警门限值返回消息数据样例{"result":
"0","timeStamp":
"xx-03-0911-27-16","configParameterList":
{"file_uploadtime":
"00:
00:
00",//上传时间，时分秒格式"file_ftpserver":
"172.16.34.200",//服务器IP地址"file_uploadpath":
"cmprobe/hgu",//服务器文件保存地址"ftpusername":
"cmprobe",//ftp用户名称"ftpuserpwd":
"Changeme_123",//ftp用户密码"userlabel":
"CMCCHGU1256",//用户标签，可以传递用户账号信息"DeviceRunningInfoData":
{"reportmode":
"MESSAGE",//上报方式，消息上报"msgreportinterval":
"600",//上报间隔，单位秒
"sampleinterval":
"60",//采样间隔，单位秒"paraList":
"WAN1Status,//WAN1口状态WAN1Type,//WAN1类型，宽带上网WAN2Status,//WAN2口状态WAN2Type,//WAN2类型，IPTVWAN3Status,//WAN3口状态WAN3Type,//WAN3类型，语音VAGStatus,CPURate,MemRate,LAN1ConnectStatus,LAN2ConnectStatus,SSID1ConnectStatus,SSID5ConnectStatus",},"TrafficData":
{"reportmode":
"FILE",//上报方式，文件上报
"filename":
"TrafficData-YYMMDDHHMMSS.txt",//上报间隔，单位秒"filereporttime":
"00:
00:
00",//上报时间，文件方式没有零点上传"sampleinterval":
"120",//采样间隔，单位秒"paraList":
"CPURate,MemRate,Bandwidth,BandwidthRate,⋯⋯"},"subDevice":
{"reportmode":
"FILE",//上报方式，文件上报"filename":
"subDevice-YYMMDDHHMMSS.txt",//上报间隔，单位秒"filereporttime":
"00:
00:
00",//上报时间，文件方式没有零点上传"sampleinterval":
"3600",//采样间隔，单位秒QB-╳╳-╳╳╳-╳╳╳╳12"paraList":
"connectmode,port,subDeviceMAC,subDeviceType,subDeviceManufacturer,subDeviceBandwidth,⋯⋯"},},"ServiceTrafficMonitor":
{"reportmode":
"MESSAGE",//上报方式，消息上报"msgreportinterval":
"600",//上报间隔，单位秒"sampleinterval":
"60",//采样间隔，单位秒"paraList":
"SIP，//源IP地址SPort，//源端口DestIP，//目标IP地址DestPort,//目标端口Protocal,//传输协议DestDNS,//服务域名信息Traffic,//流量信息DNSDelay,//域名解析时间Delay,//时延VisitNumber//访问次数}}"AlarmThresholdList":
"CPURateThreshold,MemRateThreshold,WAN1DiscardThreshold,WAN2DiscardThreshold",}7.周期上报接口在智能家庭网关软探针接收到开机上报请求的返回结果后，软探针定期采集数据，并向监控平台发送数据。
周期上报URLs:
//xxx:
port/rest/cm_softprobe/home_gateway/periodicmessage7.1.周期上报请求周期上报请求的消息体中包含一个JSON文档，具体信息如下Nullable类型含义eventTypeNBean事件类型eventCodeNInt事件号subEventYInt子事件号actualTimeYInt事件发生的服务器时间，单位为毫秒，与boot返回字段timeStamp格式一致deviceInfoNBean设备信息deviceIdNString终端序列号（即HGUSN）MacNString终
升级会员 