智能家庭網(wǎng)關(guān)軟探針與監(jiān)控平臺的接口協(xié)議征求意見版.docVIP

智能家庭網(wǎng)關(guān)軟探針與監(jiān)控平臺的接口協(xié)議征求意見版 2.范圍本協(xié)議規(guī)定了中國移動智能家庭網(wǎng)關(guān)軟探針與軟探針監(jiān)控平臺之間的接口協(xié)議，主要供智能家庭網(wǎng)關(guān)軟探針和軟探針監(jiān)控平臺開發(fā)人員使用。 3.規(guī)范性引用文件下列文件中的條款通過本標(biāo)準(zhǔn)的引用而成為本標(biāo)準(zhǔn)的條款。 凡是標(biāo)注日期的引用文件，其隨后所有的修改單（不包括勘誤的內(nèi)容）或修訂版均不適用于本標(biāo)準(zhǔn)，然而，鼓勵根據(jù)本標(biāo)準(zhǔn)達(dá)成協(xié)議的各方研究是否可使用這些文件的最新版本。 凡是不注日期的引用文件，其最新版本適用于本標(biāo)準(zhǔn)。 序號標(biāo)準(zhǔn)編號標(biāo)準(zhǔn)名稱發(fā)布單位1智能網(wǎng)關(guān)軟探針中間件數(shù)據(jù)定義規(guī)范中國移動通信集團(tuán)公司2中國移動智能家庭網(wǎng)關(guān)技術(shù)規(guī)范中國移動通信集團(tuán)公司4.術(shù)語、定義和縮略語下列術(shù)語、定義和縮略語適用于本標(biāo)準(zhǔn)詞語解釋DPI深度報文檢測技術(shù)NAT NetworkAddress Translation網(wǎng)絡(luò)地址轉(zhuǎn)換NTP Network Time Protocol網(wǎng)絡(luò)時間協(xié)議OLT OpticalLine Terminal光線路終端ONU OpticalNetwork Unit光網(wǎng)絡(luò)單元OUI OrganizationallyUnique Identifiers組織唯一標(biāo)識PPPoE PPPover Ether以太網(wǎng)上傳送PPP協(xié)議QB-3QoS Qualityof Service服務(wù)質(zhì)量RAM RandomAess Memory隨機(jī)存儲器SNMP SimpleNetwork ManagementProtocol簡單網(wǎng)絡(luò)管理協(xié)議SNTP SimpleNetworkTimeProtocol簡單網(wǎng)絡(luò)時間協(xié)議SOAP SimpleObject AessProtocol簡單對象訪問協(xié)議SSID ServiceSet Identifier服務(wù)集標(biāo)志符TCP TransmissionControl Protocol傳輸控制協(xié)議TS TransportStream傳輸流UDP UserDatagram Protocol用戶數(shù)據(jù)報協(xié)議URL UniformResource Locator統(tǒng)一資源定位格式USB UniversalSerial Bus通用串行總線VLAN VirtualLocal Area Network虛擬局域網(wǎng)WAN WideArea Network廣域網(wǎng)WLAN WirelessLAN無線局域網(wǎng)LAN LocalAreaNetwork局域網(wǎng)5.智能家庭網(wǎng)關(guān)軟探針與監(jiān)控平臺接口定義5.1.接口功能描述智能家庭網(wǎng)關(guān)軟探針通過OSGI API（建議增加到縮略語表中）采集網(wǎng)關(guān)信息以及分析通過網(wǎng)關(guān)的數(shù)據(jù)包信息，進(jìn)行預(yù)處理生成上報數(shù)據(jù)。 根據(jù)按觸發(fā)上報的不同的條件，軟探針與軟探針監(jiān)控平臺的接口可分為表5-1上報接口類型上報類型功能描述開機(jī)上報上報網(wǎng)關(guān)的基本信息，狀態(tài)信息，下掛設(shè)備信息和智能家庭網(wǎng)關(guān)軟探針的版本信息；軟探針監(jiān)控平臺返回相應(yīng)的配置參數(shù)。 周期上報上報周期內(nèi)網(wǎng)關(guān)運行的參數(shù)；上報周期內(nèi)網(wǎng)頁瀏覽，下載，即時通訊，游戲等業(yè)務(wù)參數(shù)實時上報軟探針監(jiān)控平臺下發(fā)探測指令，軟探針執(zhí)行指令，并上報結(jié)果，如Ping、Tracroute等告警上報觸發(fā)TCP連接超時，DNS解析超時等告警，軟探針將實時上傳告警信息網(wǎng)絡(luò)探測軟探針監(jiān)控平臺可根據(jù)需要向特定網(wǎng)關(guān)下發(fā)網(wǎng)絡(luò)探測任務(wù)，通過Ping或Traceroute檢驗網(wǎng)絡(luò)質(zhì)量5.2.接口結(jié)構(gòu)描述智能家庭網(wǎng)關(guān)軟探針與軟探針監(jiān)控平臺的接口分布如下圖QB-4圖5-1智能家庭網(wǎng)關(guān)軟探針與軟探針監(jiān)控平臺的接口示意圖5.3.接口協(xié)議說明智能家庭網(wǎng)關(guān)軟探針通過等應(yīng)用層協(xié)議實現(xiàn)智能家庭網(wǎng)關(guān)軟探針與軟探針監(jiān)控平臺之間的遠(yuǎn)程訪問；本協(xié)議采用TCP，智能家庭網(wǎng)關(guān)軟探針作為client向軟探針監(jiān)控平臺發(fā)起TCP連接，監(jiān)控平臺響應(yīng)后，即可關(guān)閉連接。 5.3.1.請求發(fā)起數(shù)據(jù)傳輸消息由智能家庭網(wǎng)關(guān)軟探針向軟探針監(jiān)控平臺發(fā)起訪問請求，消息格式如下Request URI默認(rèn)為“/”Host軟探針監(jiān)控平臺的域名及端口Content-Type application/JSON Content-Length表明了消息體長度；User-Agent表明了客戶端的信息；POST/1.1Host:Content-Type:Content-Length:User-Agent:Date:Aept:Referrer:QB-5Date發(fā)起請求的日期、時間Aept終端可以接收的響應(yīng)消息的媒體類型消息體中包含一個JSON文檔，詳細(xì)數(shù)據(jù)格式請參考具體接口。 5.3.2.請求返回數(shù)據(jù)接收消息由軟探針監(jiān)控平臺向智能家庭網(wǎng)關(guān)軟探針返回數(shù)據(jù)請求結(jié)果，消息格式如下Server服務(wù)器軟件信息Content-Typeapplication/JSON Content-Length消息體長度消息體中包含一個JSON文檔，詳細(xì)數(shù)據(jù)格式請參考具體接口。 5.3.3.FTP文件上傳智能家庭網(wǎng)關(guān)軟探針接收到開機(jī)上報請求的返回結(jié)果后，軟探針定期采集數(shù)據(jù)，保存到文件里面，并以FTP方式向監(jiān)控平臺發(fā)送數(shù)據(jù)。 軟探針可根據(jù)數(shù)據(jù)量大小和實時策略選擇通過FTP協(xié)議傳輸數(shù)據(jù)。 5.3.4.接口JSON數(shù)據(jù)協(xié)議定義該定義為應(yīng)用層協(xié)議，和具體采用的編碼方式無關(guān)。 為了提供服務(wù)器和機(jī)頂盒之間的交互速度，決定采用相對簡單的交互方式，采用一次交互流程進(jìn)行交互。 目前選擇的編碼方式是JSON，Bean的數(shù)據(jù)組織格式為“beanName”:“para1”:”value1”,”para2”,”value2”List ofString的數(shù)據(jù)格式為“l(fā)istName”:“value1”,”value2”S/1.1200OK Server:Content-Type:Content-Length:Date:Expires:QB-6List ofBean的數(shù)據(jù)格式為“l(fā)istName”:“para1”:”value1”,”para2”:”value2”,“para1”:”value1”,”para2”:”value2”目前，后臺端采用標(biāo)準(zhǔn)的JSON解析庫來解析數(shù)據(jù)；機(jī)頂盒端通過字符串匹配的方式來解析數(shù)據(jù)。 6.開機(jī)上報接口在智能家庭網(wǎng)關(guān)啟動時，智能家庭網(wǎng)關(guān)軟探針向軟探針監(jiān)控平臺發(fā)送數(shù)據(jù)，完成注冊過程，和監(jiān)控平臺建立連接；同時觸發(fā)監(jiān)控平臺下發(fā)采集和周期上報數(shù)據(jù)的配置。 請求URL:s:/xxx:port/rest/cm_softprobe/home_gateway/bootmessage6.1.開機(jī)上報請求開機(jī)上報請求的消息體中包含一個JSON文檔，具體信息如下Nullable類型含義eventType N Bean事件類型eventCode NInt事件號subEvent YInt子事件號（這里無效）timeOffset YInt距離該條記錄正確上報時間點的時間偏移量，正常上報為0，上報由于其他時間導(dǎo)致延遲1分鐘，上報值為60，單位為秒UserInfo usernameN String用戶名password N String密碼，基于S連接，可以不加密deviceInfo N Bean設(shè)備信息deviceId N String終端序列號(即HGU SN)manufacturer N String網(wǎng)關(guān)廠家cpu N String網(wǎng)關(guān)CPU型號hardwareVersion N String網(wǎng)關(guān)硬件版本號firmwareVersion NString網(wǎng)關(guān)固件版本model NString網(wǎng)關(guān)型號mac NString網(wǎng)關(guān)MAC地址wifiInfo NString支持的WIFI信息SSID NString SSID編號SSIDname NString SSID名字SSIDMAC NString SSIDMAC地址QB-7SSIDEnable NString使能狀態(tài)SSIDAdvertisement NString是否廣播SSIDStandard NString標(biāo)準(zhǔn)，取值為11n/11ac/11bg/11bgn/11gn/11a/11na SSIDEncryptionModeNString加密模式，取值為OPEN WEP,WPAPSK,WPAPSK2,MIXED-WPAPSK2lanIP NString LANIP地址wanIP NString WANIP地址nfcSupport Y String是否支持NFC，”Yes”,”NO”flashSize NString設(shè)備flash大小ram_size NString設(shè)備ram大小dpiVersionInfo NBean參數(shù)version NString軟探針中間件版本號interfaceVersion NString接口協(xié)議版本號deviceStatus Y Bean網(wǎng)關(guān)運行狀態(tài)bootTime NString開機(jī)時間runingTime NString運行時間CPU NString CPU占用率RAM NString內(nèi)存占用率lan1ConnectStatus NString LAN1的連接狀態(tài),tatus:string狀態(tài)取值CONNECTING CONNECTEDDISCONNECTED UNCONFIGUREDlan2ConnectStatus NString LAN2的連接狀態(tài)，取值同LAN1lan3ConnectStatus NString LAN3的連接狀態(tài)，取值同LAN1lan4ConnectStatus NString LAN4的連接狀態(tài)，取值同LAN1WAN NString WAN的連接狀態(tài)，取值同LAN1WIFI NString WIFI的連接狀態(tài)PPPOEDial NString PPPOE撥號狀態(tài)PPPOEError NString PPPOE撥號失敗原因PPPOEStatus NString PPPOE的連接狀態(tài)PONTXPower NInt PON口的發(fā)射光功率(單位0.1微瓦)PONRXPower NInt PON口的接收光功率(單位0.1微瓦)WLANNeighbor Y Bean獲取WLAN頻段鄰居信息number YInt鄰居WIFI設(shè)備數(shù)量radioInfo YBean鄰居WLAN頻段信息radioType Y String2.4G，5G SSIDNameYBeanWIFI信號名稱Mac YBean鄰居WIFI設(shè)備MAC subDeviceInfoYBean網(wǎng)關(guān)下掛設(shè)備信息QB-8subDeviceNumber Y String下掛設(shè)備數(shù)量deviceInfo YBean設(shè)備信息deviceType Y String設(shè)備類型，手機(jī)/PC/PAD deviceNameY String設(shè)備別名manufacture Y String設(shè)備廠家model Y String設(shè)備型號WLANRadioType YString2.4G，5G WLANRadioPowerYStringWLAN發(fā)射功率百分比調(diào)用參數(shù)實例eventType:eventCode:1,subEvent:0,timeOffset:0,deviceInfo:deviceId:0025E4C2D1FE5F9C,manufacturer:ABCD,Model:HS3025,MAC:E4C2D1FE5F9C,WANIP:,CPU:HILSI0038,wifiinfo:SSID:1,SSIDname:home01,SSIDMAC:E4C2D1FE5F9C,SSIDEnable:TRUE,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.開機(jī)上報響應(yīng)收到智能家庭網(wǎng)關(guān)軟探針開機(jī)上報報文后，軟探針監(jiān)控平臺發(fā)送開機(jī)上報響應(yīng)報文，把需要智能家庭網(wǎng)關(guān)軟探針采集和定期上報的信息配置下來。 開機(jī)上報響應(yīng)的消息體中包含一個JSON文檔，具體信息如下名稱單位Nullable類型含義result NInt執(zhí)行結(jié)果timeStamp NString服務(wù)器的當(dāng)前相對時間（1970-01-0100:00:00）UserInfo YString可選的修改用戶密碼能力。 username YString用戶名，不能修改password YString修改后的密碼，基于S連接，可以不加密configParameterList需要采集的數(shù)據(jù)定義QB-9file_ftpserver YString文件方式上報服務(wù)器IP地址file_uploadpath YString文件方式上報采集結(jié)果文件保存根路徑ftpusername YString FTP/SFTP用戶，加密傳輸ftpuserpwd YString FTP/SFTP密碼，加密傳輸userlabel NString用戶標(biāo)識，可以考慮加密傳輸存儲DeviceRunningInfoData reportmode YString文件方式上報，還是消息上報msgreportinterval YString消息上報的時間間隔，如10分鐘上報一次sampleinterval YString采集周期，單位秒，如30秒一次WAN1Status YString WAN1上行口狀態(tài)WAN1Type YString WAN1類型，寬帶還是語音等WAN1ConnectType YStringWAN1連接類型，如下值之一IP_Routed/IP_Bridged/PPPoE_Bridged/PPPoE_Routed WAN2Status YString WAN2上行口狀態(tài)WAN2Type YString WAN2類型，寬帶還是語音等WAN2ConnectType YString WAN2連接類型WAN3Status YString WAN3上行口狀態(tài)WAN3Type YString WAN3類型，寬帶還是語音等WAN3ConnectType YString WAN3連接類型CPURate%YString CPU利用率MemRate%YString內(nèi)存利用率LAN1ConnectStatus YString LAN1口連接狀態(tài)LAN2ConnectStatus YString LAN2口連接狀態(tài)SSID1ConnectStatus YString SSID1連接狀態(tài)SSID5ConnectStatus YString SSID2連接狀態(tài)可以自定義擴(kuò)充采集參數(shù)TrafficData網(wǎng)關(guān)數(shù)據(jù)流量信息reportmode YString文件方式上報，還是消息上報filename YString文件上報的文件名字filereporttime YString文件上報的時間sampleinterval YString采集周期，單位秒，如30秒一次QB-10averTxRate NString網(wǎng)關(guān)上行帶寬周期均值averRxRate NString網(wǎng)關(guān)下行帶寬周期均值maxTxRate NString網(wǎng)關(guān)上行帶寬周期最大maxRxRate NString網(wǎng)關(guān)下行帶寬周期最大可以自定義擴(kuò)充采集參數(shù)subDevice reportmodeYString文件方式上報，還是消息上報filename YString文件上報的文件名字filereporttime YString文件上報的時間sampleinterval YString采集周期，單位秒，如30秒一次subDeviceList connectmodeYString接入方式，LAN,WIFI,ZIGBEE等port YString LAN端口，SSID編號等subDeviceMAC YString設(shè)備MAC地址subDeviceType YString設(shè)備類型subDeviceManufacturer YString設(shè)備廠商subDeviceBandwidth YString設(shè)備帶寬可以自定義擴(kuò)充采集參數(shù)可以自定義擴(kuò)充采集數(shù)據(jù)集合ServiceTrafficMonitor業(yè)務(wù)流量監(jiān)控reportmodeYString消息上報msgreportinterval YString消息上報的時間間隔，如10分鐘上報一次sampleinterval YString采集周期，單位秒，如30秒一次SIP YString源IP地址SPort YString源端口DestIP YString目標(biāo)IP地址DestPort YString目標(biāo)端口Protocal YString傳輸協(xié)議DestDNS YString服務(wù)域名Traffic YString流量信息DNSDealy YString域名解析時間Delay YString 時延VisitNumber YString訪問數(shù)量Y StringAlarmThresholdList告警門限設(shè)置CPURateThreshold YString CPU利用率QB-11MemRateThreshold YString內(nèi)存利用率可以自定義擴(kuò)充告警門限值返回消息數(shù)據(jù)樣例result:0,timeStamp:xx-03-0911-27-16,configParameterList:file_uploadtime:00:00:00,/上傳時間，時分秒格式file_ftpserver:00,/服務(wù)器IP地址file_uploadpath:cmprobe/hgu,/服務(wù)器文件保存地址ftpusername:cmprobe,/ftp用戶名稱ftpuserpwd:Changeme_123,/ftp用戶密碼userlabel:CMCCHGU1256,/用戶標(biāo)簽，可以傳遞用戶賬號信息DeviceRunningInfoData:reportmode:MESSAGE,/上報方式，消息上報msgreportinterval:600,/上報間隔，單位秒sampleinterval:60,/采樣間隔，單位秒paraList:WAN1Status,/WAN1口狀態(tài)WAN1Type,/WAN1類型，寬帶上網(wǎng)WAN2Status,/WAN2口狀態(tài)WAN2Type,/WAN2類型，IPTV WAN3Status,/WAN3口狀態(tài)WAN3Type,/WAN3類型，語音VAGStatus,CPURate,MemRate,LAN1ConnectStatus,LAN2ConnectStatus,SSID1ConnectStatus,SSID5ConnectStatus,TrafficData:reportmode:FILE,/上報方式，文件上報filename:TrafficData-YYMMDDHHMMSS.txt,/上報間隔，單位秒filereporttime:00:00:00,/上報時間，文件方式?jīng)]有零點上傳sampleinterval:120,/采樣間隔，單位秒paraList:CPURate,MemRate,Bandwidth,BandwidthRate,subDevice:reportmode:FILE,/上報方式，文件上報filename:subDevice-YYMMDDHHMMSS.txt,/上報間隔，單位秒filereporttime:00:00:00,/上報時間，文件方式?jīng)]有零點上傳sampleinterval:3600,/采樣間隔，單位秒QB-12paraList:connectmode,port,subDeviceMAC,subDeviceType,subDeviceManufacturer,subDeviceBandwidth,ServiceTrafficMonitor:reportmode:MESSAGE,/上報方式，消息上報msgreportinterval:600,/上報間隔，單位秒sampleinterval:60,/采樣間隔，單位秒paraList:SIP，/源IP地址SPort，/源端口DestIP，/目標(biāo)IP地址DestPort,/目標(biāo)端口Protocal,/傳輸協(xié)議DestDNS,/服務(wù)域名信息Traffic,/流量信息DNSDelay,/域名解析時間Delay,/時延VisitNumber/訪問次數(shù)AlarmThresholdList:CPURateThreshold,MemRateThreshold,WAN1DiscardThreshold,WAN2DiscardThreshold,7.周期上報接口在智能家庭網(wǎng)關(guān)軟探針接收到開機(jī)上報請求的返回結(jié)果后，軟探針定期采集數(shù)據(jù)，并向監(jiān)控平臺發(fā)送數(shù)據(jù)。 周期上報URLs:/xxx:port/rest/cm_softprobe/home_gateway/periodicmessage7.1.周期上報請求周期上報請求的消息體中包含一個JSON文檔，具體信息如下Nullable類型含義eventType NBean事件類型eventCode NInt事件號subEvent YInt子事件號actualTime YInt事件發(fā)生的服務(wù)器時間，單位為毫秒，與boot返回字段timeStamp格式一致deviceInfo NBean設(shè)備信息deviceId NString終端序列號(即HGU SN)Mac NString終端MAC地址QB-13manufacturer NString網(wǎng)關(guān)廠家cpu NString網(wǎng)關(guān)CPU型號hardwareVersion NString網(wǎng)關(guān)硬件版本號firmwareVersion NString網(wǎng)關(guān)固件版本model NString網(wǎng)關(guān)型號dpiVersionInfo NBean參數(shù)version NString軟探針中間件版本號interfaceVersion NString接口協(xié)議版本號DeviceRunningInfoDataList YBean網(wǎng)關(guān)運行狀態(tài)信息列表sampletime NString采樣時間戳WAN1Status YString WAN1上行口狀態(tài)WAN1Type YString WAN1類型，寬帶還是語音等WAN1ConnectType YString WAN1連接類型WAN2Status YString WAN2上行口狀態(tài)WAN2Type YString WAN2類型，寬帶還是語音等WAN2ConnectType YString WAN2連接類型WAN3Status YString WAN3上行口狀態(tài)WAN3Type YString WAN3類型，寬帶還是語音等WAN3ConnectType YString WAN3連接類型CPURate YStringCPU利用率MemRate YString內(nèi)存利用率LAN1ConnectStatus YString LAN1口連接狀態(tài)LAN2ConnectStatus YString LAN2口連接狀態(tài)SSID1ConnectStatus YString SSID1連接狀態(tài)SSID5ConnectStatus YString SSID2連接狀態(tài)可以自定義擴(kuò)充采集參數(shù)調(diào)用參數(shù)實例eventType:eventCode:1,subEvent:0,deviceInfo:Model:HS3025,.，DeviceRunningInfoDataList:sampletime:01:26:00,/采樣時間戳WAN1Status:UP,/WAN1口狀態(tài)WAN1Type:INTERNET,/WAN1類型，寬帶上網(wǎng)WAN2Status:UP,/WAN2口狀態(tài)WAN2Type:IPTV,/WAN2類型，IPTVWAN3Status:UP,/WAN3口狀態(tài)WAN3Type:VoIP,/WAN3類型，語音CPURate:35%,MemRate:60%,LAN1ConnectStatus:CONNECTED,LAN2ConnectStatus:CONNECTED,SSID1ConnectStatus:CONNECTED,QB-14SSID5ConnectStatus:CONNECTED，sampletime:01:27:00,/采樣時間戳WAN1Status:UP,/WAN1口狀態(tài)WAN1Type:INTERNET,/WAN1類型，寬帶上網(wǎng)WAN2Status:UP,/WAN2口狀態(tài)WAN2Type:IPTV,/WAN2類型，IPTVWAN3Status:UP,/WAN3口狀態(tài)WAN3Type:VoIP,/WAN3類型，語音VAGStatus:UP,CPURate:38%,MemRate:61%,LAN1ConnectStatus:CONNECTED,LAN2ConnectStatus:CONNECTED,SSID1ConnectStatus:CONNECTED,SSID5ConnectStatus:CONNECTED,/每次采樣十次記錄數(shù)據(jù)一起上報7.2.周期上報響應(yīng)在周期上報返回值報文中，可以定義是否需要進(jìn)行測試診斷操作，該項為可選項。 測試診斷結(jié)果通過告警事件接口上報。 周期上報響應(yīng)的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義result NInt執(zhí)行結(jié)果timeStamp NString服務(wù)器的當(dāng)前相對時間（1970-01-0100:00:00）ifContinue NString是否繼續(xù)采集數(shù)據(jù)。 若是NO，則終止該采集任務(wù)。 includeOperate NInt是否包含進(jìn)一步操作0無操作1有網(wǎng)絡(luò)探測操作taskeId NString本次網(wǎng)絡(luò)探測任務(wù)ID pingTest NBean Ping測試Dest YString目的域名或者IP地址pingCount NString ping的次數(shù)(小于10次，默認(rèn)5次)packetSize YString發(fā)送的報文大小（單位字節(jié)，默認(rèn)1000字節(jié)）Interval YString連續(xù)發(fā)送報文時發(fā)送時間間隔(單位s，默認(rèn)1s)tracerouteTest NBean Traceroute測試Dest YString目的域名或者IP地址(默認(rèn)為CDN媒體服務(wù)QB-15器IP)Ttl YString設(shè)置ttl值，默認(rèn)最大30跳tracerouteCount NString Traceroute測試次數(shù)，默認(rèn)3次port YString如果協(xié)議號為6或者17，下發(fā)端口號可以擴(kuò)展其他測試功能返回消息數(shù)據(jù)樣例result:0,timeStamp:xx-03-0911-27-16,ifContinue:YES7.3.周期文件上報接口在智能家庭網(wǎng)關(guān)軟探針接收到開機(jī)上報請求的返回結(jié)果后，軟探針定期采集數(shù)據(jù)，保存到文件里面，并以FTP方式向軟探針監(jiān)控平臺發(fā)送數(shù)據(jù)。 FTP文件格式和參數(shù)文件采用TXT文本上傳文件，內(nèi)容和格式如下deviceId:OUI-45UUE99S9SD9D Begintime:yyyymmdd hhmmss-采集開始時間，時分秒格式Endtime:yyyymmdd hhmmss-采集開始時間，時分秒格式Userlable:xxxxxx-用戶標(biāo)識，可以考慮加密傳輸存儲Datatypelabel:TrafficData Sampleinterval:600Sampetime CPURateMemRate BandwidthBandwidthRate03:20:0635%68%2557%03:30:0637%69%2859%03:40:0633%68%2253%8.實時上報接口在軟探針監(jiān)控平臺向智能家庭網(wǎng)關(guān)軟探針偵下發(fā)測試命令后，軟探針啟動測試，并把測試結(jié)果上報軟探針監(jiān)控平臺。 實時上報URLs:/xxx:port/rest/cm_softprobe/home_gateway/realtime8.1.實時上報請求實時上報請求的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義eventType NBean事件類型QB-16eventCode Nint事件號subEvent Yint子事件號actualTime NLong告警發(fā)生時間deviceInfo NBean設(shè)備信息deviceId NString終端序列號(即HGU SN)mac NString終端MAC地址manufacturer NString網(wǎng)關(guān)廠家cpu NString網(wǎng)關(guān)CPU型號hardwareVersion NString網(wǎng)關(guān)硬件版本號firmwareVersion NString網(wǎng)關(guān)固件版本model NString網(wǎng)關(guān)型號dpiVersionInfo NBean參數(shù)version NString軟探針中間件版本號interfaceVersion NString接口協(xié)議版本號alarmTaskFlag NString“1”代表告警任務(wù)引發(fā)的網(wǎng)絡(luò)測試，“0”代表其他任務(wù)引發(fā)的網(wǎng)絡(luò)測試taskId NString本次網(wǎng)絡(luò)探測任務(wù)ID dest NString目的域名或者IP地址pingResult NBean Ping結(jié)果信息nodeIp NString網(wǎng)元節(jié)點ip地址avgPingCost NString Ping平均延時pingCnt NString Ping總次數(shù)pingReachCnt NString Ping成功次數(shù)lossRate NString Ping丟包率tracerouteResultList NList ofbean Traceroute結(jié)果信息hops NInt跳數(shù)序列號nodeIp NString網(wǎng)元節(jié)點ip地址nodeName NString網(wǎng)元節(jié)點網(wǎng)絡(luò)名delays NString延時信息tm1，tm2，tm3單位毫秒例10,20,50如某次連接不可達(dá)，取值為（-1）8.2.實時上報響應(yīng)實時上報響應(yīng)的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義Result Int執(zhí)行結(jié)果QB-179.告警上報接口在智能家庭網(wǎng)關(guān)軟探針偵測到異常事件滿足告警閾值時，軟探針向監(jiān)控平臺發(fā)送監(jiān)控數(shù)據(jù)。 告警上報URLs:/xxx:port/rest/cm_softprobe/home_gateway/alarm9.1.告警上報請求告警上報請求的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義eventType NBean事件類型eventCode Nint事件號subEvent Yint子事件號actualTime NLong告警發(fā)生時間deviceInfo NBean設(shè)備信息deviceId NString終端序列號(即HGU SN)manufacturer NString網(wǎng)關(guān)廠家cpu NString網(wǎng)關(guān)CPU型號hardwareVersion NString網(wǎng)關(guān)硬件版本號firmwareVersion NString網(wǎng)關(guān)固件版本model NString網(wǎng)關(guān)型號dpiVersionInfo NBean參數(shù)version NString軟探針中間件版本號interfaceVersion NString接口協(xié)議版本號alarmInfo alarmSequenceNoNString告警流水號，一個網(wǎng)關(guān)唯一的alarmName NString告警名字，說明哪個告警門限發(fā)生了告警alarmDescription NString說明告警的內(nèi)容9.2.告警上報響應(yīng)在周期上報與實時上報返回報文中，可以定義是否需要進(jìn)行測試診斷操作，是可選項。 測試診斷結(jié)果通過告警事件接口上報。 告警上報響應(yīng)的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義Result Int執(zhí)行結(jié)果includeOperate NInt是否包含進(jìn)一步操作0無操作1有網(wǎng)絡(luò)探測操作taskeId NString本次網(wǎng)絡(luò)探測任務(wù)ID QB-18pingTestNBean Ping測試Dest YString目的域名或者IP地址pingCount NString ping的次數(shù)(小于10次，默認(rèn)5次)packetSize YString發(fā)送的報文大小（單位字節(jié)，默認(rèn)1000字節(jié)）Interval YString連續(xù)發(fā)送報文時發(fā)送時間間隔(單位s，默認(rèn)1s)tracerouteTest NBean Traceroute測試Dest YString目的域名或者IP地址(默認(rèn)為CDN媒體服務(wù)器IP)Ttl YString設(shè)置ttl值，默認(rèn)最大30跳tracerouteCount NString Traceroute測試次數(shù)，默認(rèn)3次port YString如果協(xié)議號為6或者17，下發(fā)端口號可以擴(kuò)展其他測試功能10.網(wǎng)絡(luò)探測接口當(dāng)監(jiān)控平臺需要主動發(fā)起測試動作時，主動向智能家庭網(wǎng)關(guān)軟探針發(fā)起網(wǎng)絡(luò)探測任務(wù)。 主動測試URLs:/xxx:port/rest/cm_softprobe/home_gateway/test10.1.主動測試請求主動測試請求的消息體中包含一個JSON文檔，具體信息如下名稱Nullable類型含義eventType NBean事件類型eventCode Nint事件號 (5)subEvent Nint子事件號deviceInfo NBean設(shè)備ID deviceId NString終端序列號(即HG SN)mac NString設(shè)備MAC地址Reboot YInt0不需要重起，正數(shù)代表多少秒后重起。 單位秒taskId NString本次網(wǎng)絡(luò)探測任務(wù)ID pingTestNBeanPing測試dest NString目的域名或者IP地址pingCount NString ping的次數(shù)(小于10次，默認(rèn)5次)packetSize YString發(fā)送的報文大?。▎挝蛔止?jié)，默認(rèn)1000字節(jié)）interval YString連續(xù)發(fā)送報文時發(fā)送時間間隔(單位s，默認(rèn)1s)tracerouteTest NBean Traceroute測試QB-19destNString目的域名或者IP地址ttl YStr