智能家庭网关软探针与监控平台的接口协议征求意见版
智能家庭网关软探针与监控平台的接口协议征求意见版
2. 范围本协议规定了中国移动智能家庭网关软探针与软探针监控平台之间的接口协议，主要供智能家庭网关软探针和软探针监控平台开发人员使用。
3. 规范性引用文件下列文件中的条款通过本标准的引用而成为本标准的条款。
凡是标注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件，其最新版本适用于本标准。序号标准编号标准名称发布单位[1] 《智能网关软探针中间件数据定义规范》中国移动通信集团公司[2] 《中国移动智能家庭网关技术规范》中国移动通信集团公司 4. 术语、定义和缩略语下列术语、定义和缩略语适用于本标准词语解释DPI 深度报文检测技术NAT NetworkAddress Translation 网络地址转换NTP Network Time Protocol 网络时间协议OLT OpticalLine Terminal 光线路终端ONU OpticalNetwork Unit 光网络单元OUI OrganizationallyUnique Identifiers 组织唯一标识PPPoE PPPover Ether 以太网上传送PPP 协议QB-╳╳ - ╳╳╳ - ╳╳╳╳ 3QoS Qualityof Service 服务质量RAM RandomAess Memo随ry 机存储器SNMP SimpleNetwork ManagementProtocol 简单网络管理协议SNTP
SimpleNetworkTimeProtocol 简单网络时间协议SOAP SimpleObject AessProtocol 简单对象访问协议SSID ServiceSet Identifier 服务集标志符TCP TransmissionControl Protocol 传输控制协议TS TransportStream 传输
流UDP UserDatagram Protocol 用户数据报协议URL UniformResource Locator 统一资源定位格式USB UniversalSerial Bus 通用串行总线VLAN VirtualLocal Area Network 虚拟局域网WANW ideArea Network 广域网WLANW irelessLAN 无线局域网LAN LocalAreaNetwork 局域网 5. 智能家庭网关软探针与监控平台接口定义 5.1. 接口功能描述智能家庭网关软探针通过OSGI API（建议增加到缩略语表中）采集网关信息以及分析通过网关的数据包信息，进行预处理生成上报数据。
根据按触发上报的不同的条件，软探针与软探针监控平台的接口可分为表5-1 上报接口类型上报类型功能描述开机上报上报网关的基本信息，状态信息，下挂设备信息和智能家庭网关软探针的版本信息；软探针监控平台返回相应的配置参数。
周期上报上报周期内网关运行的参数；上报周期内网页浏览，下载，即时通讯，游戏等业务参数实时上报软探针监控平台下发探测指令，软探针执行指令，并上报结果，如Ping 、Tracroute 等告警上报触发TCP连接超时，DNS解析超时等告警，软探针将实时上传告警信
息网络探测软探针监控平台可根据需要向特定网关下发网络探测任务，通过Ping 或Traceroute 检验网络质量 5.2. 接口结构描述智能家庭网关软探针与软探针监控平台的接口分布如下图QB-╳╳- ╳╳ ╳-
╳╳╳╳ 4图5-1 智能家庭网关软探针与软探针监控平台的接口
示意图 5.3. 接口协议说明智能家庭网关软探针通过等应用层协议实现智能家庭网关软探针与软探针监控平台之间的远程访问；本协议采用TCP，智能家庭网关软探针作为client 向软探针监控平台发起TCP 连接，监控平台响应后，即可关闭连接。
5.3.1. 请求发起数据传输消息由智能家庭网关软探针向软探针监控
平台发起访问请求，消息格式如下Request URI 默认为“ / ”Host 软探
针监控平台的域名及端口Content-Type application/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-Typeapplication/JSON Content-Length 消息体长度消息体中包含一个JSON文档，详细数据格式请参考具体接口。
5.3.3. FTP 文件上传智能家庭网关软探针接收到开机上报请求的返回结果后，软探针定期采集数据，保存到文件里面，并以FTP方式向监控平台发送数据。
软探针可根据数据量大小和实时策略选择通过FTP 协议传输数据。
5.3.4. 接口JSON数据协议定义该定义为应用层协议，和具体采用的编码方式无关。
为了提供服务器和机顶盒之间的交互速度，决定采用相对简单的交互方式，采用一次交互流程进行交互。
目前选择的编码方式是JSON，Bean的数据组织格式为“beanNam”e :{ “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解析库来解析数据；机顶盒端通过字符串匹配的方式来解析数据。
6. 开机上报接口在智能家庭网关启动时，智能家庭网关软探针向软探针监控平台发送数据，完成注册过程，和监控平台建立连接；同时触发监控平台下发采集和周期上报数据的配置。
请求URL:s://xxx:port/rest/cm_softprobe/home_gateway/bootmessage 6.1. 开机上报请求开机上报请求的消息体中包含一个JSON文档，具体信息如下Nullable 类型含义eventType N Bean事件类型eventCode NInt 事件号subEvent YInt 子事件号（这里无效）timeOffset 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 网关固件版本model NString 网关型号mac NString 网关MAC地址wifiInfo NString 支持的WIFI 信息SSID NString SSID 编号SSIDname NString SSID 名字SSIDMAC NString SSIDMAC地址QB-╳╳ - ╳╳╳ - ╳╳╳╳ 7SSIDEnable NString 使能
状态SSIDAdvertisement NString 是否广播SSIDStandard NString 标准，取值为11n/11ac/11bg/11bgn/11gn/11a/11na SSIDEncryptionModeNString 加密模式，取值为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 网关运行状态bootTime NString 开机时间runingTime NString 运行时间CPU NString CPU占用率RAM NString 内存占用率lan1ConnectStatus NString LAN1 的连接状态,tatus:string 状态取值CONNECTING CONNECTEDDISCONNECTED UNCONFIGUREDlan2ConnectStatus NString LAN2的连接状态，取值同LAN1lan3ConnectStatus NString LAN3 的连接状态，取值同
LAN1lan4ConnectStatus NString LAN4的连接状态，取值同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 设备数量radioInfo 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 设备型号WLANRadioType 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"," 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 类型含义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 文件方式上报采
集结果文件保存根路径ftpusername YString FTP/SFTP 用户，加密传输
ftpuserpwd YString FTP/SFTP 密码，加密传输userlabel NString 用户标识，可以考虑加密传输存储DeviceRunningInfoData reportmode YString 文件方式上报，还是消息上报msgreportinterval YString 消息上报的时间间隔，如10 分钟上报一次sampleinterval YString 采集周期，单位秒，如
30 秒一次WAN1StatusY String WAN1上行口状态WAN1TypeY String
WAN1类型，宽带还是语音等WAN1ConnectTypeY StringWAN1连接类
型，如下值之
IP_Routed/IP_Bridged/PPPoE_Bridged/PPPoE_Routed
WAN2StatusY String WAN2上行口状态WAN2TypeY String WAN2类型，宽带还是语音等WAN2ConnectType YString WAN2连接类型
WAN3StatusY String WAN3上行口状态WAN3TypeY String WAN3类型，宽带还是语音等WAN3ConnectType YString WAN3连接类型CPURate%YString CPU利用率MemRate%YString内存利用率
LAN1ConnectStatus YString LAN1 口连接状态LAN2ConnectStatus YString LAN2 口连接状态SSID1ConnectStatus YString SSID1 连接状态
SSID5ConnectStatus YString SSID2 连接状态??可以自定义扩充采集参数TrafficData 网关数据流量信息reportmode YString 文件方式上报，还是消息上报filename YString 文件上报的文件名字filereporttime YString 文件上报的时间sampleinterval YString 采集周期，单位秒，如30秒一次QB-╳╳ - ╳╳╳ - ╳╳╳╳ 10averTxRate NString 网关上行带宽周期均值averRxRate NString 网关下行带宽周期均值maxTxRate NString 网关上行带宽周期最大maxRxRate NString 网关下行带宽周期最大??可以自定义扩充采集参数subDevice reportmodeYString 文件方式上报，还是消息上报filename YString 文件上报的文件名字filereporttime YString 文
件上报的时间sampleinterval YString 采集周期，单位秒，如30 秒一次subDeviceList connectmodeYString 接入方式，LAN,WIFI,ZIGBEE等port
YString LAN 端口，SSID编号等subDeviceMAC YString 设备MAC地址subDeviceType YString 设备类型subDeviceManufacturer YString 设备厂商subDeviceBandwidth YString 设备带宽??可以自定义扩充采集参数??可以自定义扩充采集数据集合ServiceTrafficMonitor 业务流量监控reportmodeYString 消息上报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 YString 访问数量??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/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类型，IPTV WAN3Status,//WAN3口状态
WAN3Type,//WAN3类型，语音
VAGStatus,CPURate,MemRate,LAN1ConnectStatus,LAN2ConnectStat
us,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,s ubDeviceManufacturer,subDeviceBandwidth, ??"},},"ServiceTrafficMonitor":{"reportmode":"MESSAGE",// 上报方式，消息上报"msgreportinterval":"600",// 上报间隔，单位秒"sampleinterval":"60",// 采样间隔，单位秒"paraList":"SIP ，// 源IP地址SPort ，// 源端口DestIP ，// 目标IP地址DestPort,// 目标端口Protocal,// 传输协议DestDNS,// 服务域名信息Traffic,// 流量信息DNSDelay,// 域名解析时间Delay,// 时延VisitNumber// 访问次
数}}"AlarmThresholdList":"CPURateThreshold,MemRateThreshold ,WAN1Dis cardThreshold,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终端MAC地址QB-╳╳ - ╳╳╳ - ╳╳╳╳ 13manufacturer NString 网关厂家cpu NString 网关CPU型号hardwareVersion NString 网关硬件版本号firmwareVersion NString 网关固件版本model NString 网关型号dpiVersionInfo NBean参数version NString 软探针中间件版本号interfaceVersion NString 接口协议版本号DeviceRunningInfoDataList YBean 网关运行状态信息列表sampletime NString 采样时间戳
WAN1Status YString WAN1 上行口状态WAN1Type YString WAN1类型，宽带还是
语音等WAN1ConnectTypeY String WAN连1 接类型WAN2StatusY String WAN2上行口状态WAN2Type YString WAN2类型，宽带还是语音等WAN2ConnectType YString WAN2连接类型WAN3Status YString WAN3 上
行口状态WAN3Type YString WAN3类型，宽带还是语音等
WAN3ConnectType YString WAN3连接类型CPURate YStringCPU利用
率MemRate YString 内存利用率LAN1ConnectStatus YString LAN1 口连接状态LAN2ConnectStatus YString LAN2 口连接状态
SSID1ConnectStatus YString SSID1 连接状态SSID5ConnectStatus YString SSID2 连接状态??可以自定义扩充采集参数调用参数实例{"eventType":{"eventCode":"1","subEvent":"0"},"deviceInfo": {"Model":"HS3025", ..... }，
"DeviceRunningInfoDataList":[{"sampletime":"01:26:00",// 采样时间戳"WAN1Status":"UP",//WAN1 口状态"WAN1Type":"INTERNET",//WAN1类型，宽带上网"WAN2Status":"UP",//WAN2 口状态
"WAN2Type":"IPTV",//WAN2 类型，IPTV"WAN3Status":"UP",//WAN3 口状态"WAN3Type":"VoIP",//WAN3 类型，语音"CPURate":"35%","MemRate":"60%","LAN1ConnectStatus":"CONNEC TED","LAN2ConnectStatus":"CONNECTED","SSID1ConnectStatus":" CONNECTED",Q╳B-╳ - ╳╳╳ - ╳╳╳╳
14"SSID5ConnectStatus":"CONNECTED"}，{"sampletime":"01:27:00",// 采样时间戳
"WAN1Status":"UP",//WAN1 口状态"WAN1Type":"INTERNET",//WAN1 类型，宽带上网"WAN2Status":"UP",//WAN2 口状态
"WAN2Type":"IPTV",//WAN2 类型，IPTV"WAN3Status":"UP",//WAN3 口状态"WAN3Type":"VoIP",//WAN3 类型，语音
"VAGStatus":"UP","CPURate":"38%","MemRate":"61%","LAN1Conne ctStatus":"CONNECTED","LAN2ConnectStatus":"CONNECTED","SSID
1ConnectStatus":"CONNECTED","SSID5ConnectStatus":"CONNECTED "}, ??/// 每次采样十次记录数据一起上报]}7.2. 周期上报响应在周期上报返回值报文中，可以定义是否需要进行测试诊断操作，该项为可选项。
测试诊断结果通过告警事件接口上报。周期上报响应的消息体中包含一个JSON文档，具体信息如下名称Nullable 类型含义result NInt 执行结果timeStamp NString 服务器的当前相对时间（1970-01-
0100:00:00 ）ifContinue NString 是否继续采集数据。
若是NO，则终止该采集任务。
includeOperate NInt 是否包含进一步操作0 无操作 1 有网络探测操作taskeId NString 本次网络探测任务ID pingTest NBean Ping 测试Dest YString 目的域名或者IP 地址pingCount NString ping 的次数（小于10次，默认5次）packetSize YString 发送的报文大小（单位字节，默认1000字节）Interval YString 连续发送报文时发送时间间隔（单位s，默认1s）tracerouteTest NBean Traceroute 测
试Dest YString 目的域名或者IP 地址（默认为CDN媒体服务QB-╳ ╳- ╳╳╳ - ╳╳╳╳ 15器IP）Ttl YString 设置ttl 值，默认最大30 跳tracerouteCount NString Traceroute 测试次数，默认 3 次port YString 如果协议号为 6 或者17，下发端口号??可以扩展其他测试功能返回消息数据样例{"result":"0","timeStamp":"xx-03-0911-27-
16","ifContinue":" YES"}7.3. 周期文件上报接口在智能家庭网关软探针接收到开机上报请求的返回结果后，软探针定期采集数据，保存到文件里面，并以FTP方式向软探针监控平台发送数据。
FTP 文件格式和参数文件采用TXT 文本上传文件，内容和格式如下deviceId:OUI-45UUE99S9SD9D Begintime:yyyymmdd hhmmss-- 采集开始时间，时分秒格式Endtime:yyyymmdd hhmmss--采集开始时间，时分秒格式Userlable:xxxxxx-- 用户标识，可以考虑加密传输存储Datatypelabel:TrafficData Sampleinterval:600Sampetime CPURateMemRate BandwidthBandwidthRate??03:20:0635%68%2557%??
03:30:0637%69%2859%??03:40:0633%68%2253%????8. 实时上报接口在软探针监控平台向智能家庭网关软探针侦下发测试命令后，软探针启动测试，并把测试结果上报软探针监控平台。
实时上报
URLs://xxx:port/rest/cm_softprobe/home_gateway/realtime8.1. 实时上报请求实时上报请求的消息体中包含一个JSON文档，具体信息如下名称Nullable 类型含义eventType NBean 事件类型QB-╳╳ - ╳╳╳ -
╳╳╳╳ 16eventCode Nint 事件号subEvent Yint 子事件号actualTime NLong 告警发生时间deviceInfo NBean 设备信息deviceId NString 终端序列号（即HGU SN）mac NString终端MAC地址manufacturer NString 网关厂家cpu NString 网关CPU型号hardwareVersion NString 网关硬件版本号firmwareVersion NString 网关固件版本model NString 网关型号dpiVersionInfo NBean参数version NString 软探针中间件版本号
interfaceVersion NString 接口协议版本号alarmTaskFlag NString “1”代表告警任务引发的网络测试，“0”代表其他任务引发的网络测试taskId NString 本次网络探测任务ID dest NString 目的域名或者IP 地址pingResult NBean Ping 结果信息nodeIp NString 网元节点ip 地址avgPingCost NString Ping 平均延时pingCnt NString Ping 总次数pingReachCnt NString Ping 成功次数lossRate NString Ping 丢包率tracerouteResultList NList ofbean Traceroute 结果信息hops NInt 跳数序列号nodeIp NString 网元节点ip 地址nodeNameN String 网元节点网络名delays NString 延时信息{tm1，tm2，tm3} 单位毫秒例{10,20,50} 如某次连接不可达，取值为（-1 ）8.2. 实时上报响应实时上报响应的消息体中包含一个JSON文档，具体信息如下名称Nullable 类型含义Result Int 执行结果QB-╳╳ - ╳╳╳ -╳╳╳╳ 179.告警上报接口在智能家庭网关软探针侦测到异常事件满足告警阈值时，软探针向监控平台发送监控数据。
告警上报
URLs://xxx:port/rest/cm_softprobe/home_gateway/alarm9.1. 告警上报请求告警上报请求的消息体中包含一个JSON文档，具体信息如下名称Nullable 类型含义eventType NBean 事件类型eventCode Nint 事件号subEvent Yint 子事件号actualTime NLong 告警发生时间deviceInfo NBean设备信息deviceId NString 终端序列号（即HGU SN）manufacturer NString 网关厂家cpu NString 网关CPU型号hardwareVersion NString 网关硬件版本号firmwareVersion NString 网关固
件版本model NString 网关型号dpiVersionInfo NBean参数version NString 软探针中间件版本号interfaceVersion NString 接口协议版本号alarmInfo alarmSequenceNoNString 告警流水号，一个网关唯一的alarmNameN String 告警名字，说明哪个告警门限发生了告警alarmDescription NString 说明告警的内容9.2. 告警上报响应在周期上报与实时上报返回报文中，可以定义是否需要进行测试诊断操作，是可选项。
测试诊断结果通过告警事件接口上报。告警上报响应的消息体中包含一个JSON文档，具体信息如下名称Nullable 类型含义Result Int 执行结果includeOperate NInt 是否包含进一步操作0 无操作 1 有网络探测操作taskeId NString 本次网络探测任务ID QB- ╳╳ - ╳╳╳ -
╳╳╳╳ 18pingTestNBean Ping 测试Dest YString 目的域名或者IP 地址pingCount NString ping 的次数（小于10次，默认5次）packetSize YString 发送的报文大小（单位字节，默认1000字节）Interval YString 连续发送报文时发送时间间隔（单位s，默认1s）tracerouteTest NBeanT raceroute 测试Dest YString 目的域名或者IP 地址（默认为CDN媒体服务器IP）Ttl YString 设置ttl 值，默认最大30 跳tracerouteCount NString Traceroute 测试次数，默认 3 次port YString 如果协议号为 6 或者17，下发端口号??可以扩展其他测试功能10. 网络探测接口当监控平台需要主动发起测试动作时，主动向智能家庭网关软探针发起网络探测任务。
主动测试URLs://xxx:port/rest/cm_softprobe/home_gateway/test10.1. 主
动测试请求主动测试请求的消息体中包含一个JSON文档，具体信息
如下名称Nullable 类型含义eventType NBean 事件类型eventCode Nint 事件号
（5）subEvent Nint 子事件号deviceInfo NBean 设备ID deviceId
NString 终端序列号（即HG SN）mac NString 设备MAC地址Reboot YInt0 不需要重起，正数代表多少秒后重起。
单位秒taskId NString 本次网络探测任务ID pingTestNBeanPing 测试dest NString 目的域名或者IP 地址pingCount NString ping 的次数（小于10次，默认5次）packetSize YString 发送的报文大小（单位字节，默认1000字节）interval YString 连续发送报文时发送时间间隔（单位s，默认1s）tracerouteTest NBean Traceroute 测
试QB-╳╳ - ╳╳╳ - ╳╳╳╳ 19destNString 目的域名或者IP 地址
ttl YString 设置ttl 值，默认最大30 跳tracerouteCount NString Traceroute 测试次数，默认 3 次captureTest NBean 抓包大小达到要求即停止抓包filterRule NString 过滤规则capFileName YString 本次上传的抓包文件的名称( 例xx07101532-55_sn.pcap)configParameterList NBean 需要设置的参数secondMonitor NString 上报时间间隔，单位秒??可以扩展其他测试功能报文样例{“eventType”:{“eventCode”:”5”,“subEvent”: ” 51”},"deviceInfo":{"deviceId":"xx0808",// 终端序列号},
“ taskId ”: ”007”,“pingTest“:{“ dest ”: ”.baidu. ”,“ pingCount ”: ” 2
”, “packetSize ”: ””,“interval ”: ””}, “tracerouteTest ”” {“dest ”: ”.baidu. ”,“ttl ”: ””,“ tracerouteCount ”: ””}}10.2. 主动测试响应智能家庭网关软探针收到测试请求后，向软探针监控平台发送200OK。
然后进行测试操作，等待测试结束上报结果到软探针监控平台，正常软探针监控平台将返回200OK。
QB- ╳╳ - ╳╳╳ - ╳╳╳╳ 20主动测试响应的消息体中包含一个JSON文档，具体信息如下eventType NBean事件类型eventCode Nint 事件号subEvent Yint 子事件号deviceInfo NBean 设备信息deviceIdNString 终端序列号mac NString 设备MAC地址alarmTaskFlag NString “ 1”代表告警任务引发的网络测试，“ 0” 代表其他任务引发的网络测试taskId NString 本次网络探测任务ID destNString 目的域名或者IP 地址pingResult NBeanPing 结果信息nodeIp NString 网元节点
ip 地址avgPingCost NString Ping 平均延时pingCnt NString Ping 总次数pingReachCnt NString Ping 成功次数lossRate NString Ping 丢包率tracerouteResultList NList ofbean Traceroute 结果信息hops NInt 跳数序列号nodeIp NString 网元节点ip 地址nodeNameN String 网元节点网络名delays NString 延时信息{tm1 ，tm2，tm3}单位毫秒例{10,20,50} 如某次连接不可达，取值为（-1 ）JSON格式样例（以PING为例）
{ “deviceid ”: ”noc196”,
“mac”: ”00:1e:73:ab:50:38 ”,“pingAddr ”:{ “dest ”: ”.baidu. ”, “ipAddr ”: ”115.239.210.26 ”}, “pingResult ”:[{ “reachable ”: ”
1”,“icmpSeq”:”1”,“ttl ”: ”54”,“time”:”10.9”,},QB- ╳╳ - ╳╳╳ - ╳╳╳╳ 21{“reachable ”:”0”,“icmpSeq”: ””,
“ttl ”:””,“time ”: ””,},]}11. 编制历史版本号更新时间主要内容或重大修改编制人技术审核人部门审核人V1.0.0xx-07-08 根据中国移动需求撰写文档内容QB-╳╳ - ╳╳╳ - ╳╳╳╳ 22附录A常量表EventCode: 值含义1BOOT事件2PERIODIC事件3ALARM事件
45CONNECTION REQUE事S件T -网络测试6Result: 值含义0成功-1 数据格式错误-3 参数格式错误-4 系统错误-5 错误subEventCode: 暂无。
内容仅供参考