机顶盒软探针与监控平台的接口协议规范征求意见版Word下载.docx

1、”value1”,”para2”,”value2”List ofString的数据格式为“listName”:“value1”,”value2”List of Bean的数据格式为“listName”:“para1”:”value1”,”para2”:”value2”,“para1”:”value2”目前，后台端采用标准的json解析库来解析数据；机顶盒端通过字符串匹配的方式来解析数据。 6.1.BOOT接口（IF1）6.1.1.BOOT请求消息方向软探针（启动数据）软探针监控平台消息格式如下Request URI默认为“/”Host软探针监控平台的域名及端口Content-Type appl

2、ication/json Content-Length表明了消息体长度；User-Agent表明了客户端的信息；Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型POST/1.1Host:Content-Type:Content-Length:User-Agent:Date:Aept:Referrer:QB-5消息体中包含一个json文档，具体信息如下表6-1BOOT请求payload信息名称Nullable类型含义eventType N Bean事件类型eventCode NInt事件号subEvent YInt子事件号（这里无效）timeOffset NInt距离该条记录

3、正确上报时间点的时间偏移量，正常上报为0，上报由于其他时间导致延迟1分钟，上报值为60，单位为秒deviceInfo N Bean设备信息deviceId N String终端序列号（即STB ID）imsi Y String IMSIcpu N String CPU型号version N String Android系统版本号release N String机顶盒固件版本model N String机顶盒型号manufacturer N String机顶盒厂家baseParameterList N Bean参数version N String软探针中间件版本号interfaceVersion

4、 N String接口协议版本号wifiProtocol N String路由器的wifi的协议版本，802.11a/g/b/n/ac，具体实现待调研lastRuntimeInfo Y Bean机顶盒上次运行信息lastStartMoment Y String机顶盒上次开机的时间（1970-01-0100:00:00）lastRunTime Y String机顶盒上次运行时长cpInfo YBean牌照方信息cpName Y String牌照方名字，由平台下发，如GITV，TV，WASU等systemInfo Bean系统信息ssid Y String无线热点的SSID workIdY Str

5、ing无线热点的信道个数gateway Y String当前局域网网关地址dns YString当前局域网DNS地址linkSpeed YString无线热点的带宽（单位Mbps）aessMethod N*String网络接入方式（“0”为wifi,“1”为有线,“2”为PPPOE）wirelessSignalStrength Y*String无线信号强度（单位微伏db）gatewayMac YString网关mac样例如下QB-6eventType:eventCode1,subEvent0,deviceInfodeviceIdxx0808,/终端序列号romInfo1.0.0basePara

6、meterListversion1.00.00.01interfaceVersionconnectionURL221.226.67.42:13852/可为空，秒级用（备用接口）,hopsIp172.16.34.254,*,221.226.67.41,*,221.231.191.169systemInfoaessMethodwirelessSignalStrength-30.0,/单位dbgatewayMac006.1.2.BOOT响应消息方向软探针监控平台软探针（启动数据）消息格式如下Server服务器软件信息S/1.1200OK Server:Expires:QB-7Content-Type

7、application/json Content-Length消息体长度消息体中包含一个json文档，具体信息如下表6-2BOOT响应payload信息名称单位Nullable类型含义timeStamp毫秒String服务器的当前相对时间（1970-01-0100:00）configParameterList Bean需要设置的参数keepalivePeriodic毫秒N String keepalive定期上报事件间隔（默认值:10*60*1000毫秒）programInfoPeriodic毫秒NString节目播放后，节目信息定期记录的间隔（默认值:10*60*1000毫秒）。 epgRe

8、spThreshold毫秒NString EPG请求响应时长告警阈值（默认值:6000）vodRespThreshold NString媒体文件播放失败告警（MediaPlayer的onError事件）m3u8RespThreshold毫秒NString m3u8请求响应时长告警阈值（默认值:800）tsRespThreshold毫秒NStringts请求响应时长告警阈值（默认值:800）exit NString是否上报数据0-继续上报，1-停止上报stutterThreshold X毫秒内卡顿Y次或者单次卡顿时长超过Z毫秒NString卡顿告警阈值（根据总次数、总时长、最长卡顿时长等确定。

9、参考标准为120*1000毫秒内卡顿总时长15000毫秒，单次最长5000毫秒）如默认120000毫秒内卡顿总次数为10次或者累计卡顿总时长超过15000毫秒或者单次卡顿时长超过5000毫秒（120000,10,15000,5000），不需要的下发值赋-1cpInfoList NList of Bean牌照方相关信息cpName NString牌照方包括GITV（银河），TV（未来电视），WASU（视频基地华数）cpAppNameList NString某个牌照方应用对应的包名列表，如银河为.galaxyitv.launcher.galaxyitv.video.gitv.tv.live.git

10、v.tv.launcher.gitv.launcher，使用逗号分割开cpEpgIPList NString某个牌照方对应的EPG的ip地址列QB-8表，使用逗号分割开alarmCaptureEn NString是否需要上传抓包文件（默认值:0）0不抓取，1抓取captureEn NString是否立即抓取（默认值:0）0不抓取，1开始抓取，2停止抓取filterRule NString过滤规则ftpServerAddr YString抓包文件上传的FTP服务器地址ftpUser YString ftp服务器登录用户名ftpPasswd YString ftp服务器登录密码startSecon

11、dMonitor YString是否立即开启秒级监控，0不开启，1开启，2，停止样例如下configParameterListunderThresholdPercentage12keepalivePeriodic10,/单位为分钟programInfoPeriodic20epgResponseThreshold6000,/单位为msvodResponseThreshold800m3u8ResponseThresholdexit,/1为强制退出QosMoncaptureEn,/需要qosmon上传抓包文件ftpServerAddr172.16.34.200ftpUsertestftpPasswd

12、test123，uploadVodInfoEn“taskId”:”007”,“pingTestPeriod”:“dest”:”.baidu.”,“pingCount”:”2”,“packetSize”:”,“interval”:”,“beginTime”:“”,“endTime”:“”,“periodTaskInterval”:“”,“tracerouteTestPeriod”QB-9“dest”:”.baidu.”,“ttl”:”,“tracerouteCount”:“”,“bandwidthTestPeriod”:”.baidu.”,/如果subEvent为52,此处填测速服务器地址“te

13、stTime”:”,/如果subEvent为52，此处填测速时间（单位:秒）“protocolType”:”1”,“port”:“”6.2.PERIODIC接口（IF2）6.2.1.PERIODIC请求消息方向软探针（监控数据）软探针监控平台消息格式如下Request URI默认为“/”Host软探针监控平台的域名及端口Content-Type application/json POST/1.1Host:QB-10Content-Length表明了消息体长度；Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型消息体中包含一个json文档，具体信息如下表6-3PERIODIC请

14、求payload信息名称Nullable类型含义eventType NBean事件类型eventCode Nint事件号subEvent Yint子事件号actualTime NLong事件发生的服务器时间，单位为毫秒，与boot返回字段timeStamp格式一致deviceInfo NBean设备信息deviceId NString终端序列号（即STB ID）imsi YString IMSIcpu NString CPU型号version NString Android系统版本号release NString机顶盒固件版本model NString机顶盒型号manufacturer NSt

15、ring机顶盒厂家baseParameterList NBean参数Version NString软探针中间件版本号interfaceVersion NString接口协议版本号stutterInfo YBean卡顿信息stutterAllTime YString本次keepalive内卡顿总时长（单位毫秒）stutterAllCnt YString本次keepalive内卡顿总次数cpInfo NBean牌照方信息cpName YString牌照方名字，由平台下发，如GITV，TV，WASU等appLive NString牌照方应用是否在运行（“0”为未运行，“1”在运行）m3u8Info

16、NBean所请求的m3u8信息统计m3u8ReqCnt YString m3u8文件请求总次数m3u8ReqReachCnt YString m3u8文件请求成功次数avgM3u8SessionCost YString m3u8文件请求响应平均延时（单位毫秒）tsInfo NBean请求的媒体文件请求信息统计tsReqCnt YString媒体文件请求总次数tsReqReachCnt YString媒体文件请求成功次数QB-11avgTsSessionCost YString媒体文件请求响应平均延时（单位毫秒）epgInfo NBean所请求的epg信息统计epgReqCnt YString

17、epg请求总次数epgReqReachCnt Y-String EPG请求成功次数avgEpgSessionCost Y-StringEPG请求响应平均时延（单位毫秒）tcpConnectInfo NBean所请求的tcp连接信息统计tcpConnectCnt YString TCP连接总次数tcpConnectReachCnt Y-String TCP连接成功次数avgTcpConnectCost Y-String TCP建立连接平均时长（单位毫秒）avgTcpretran NString平均重传率stbPlayingStatus NString用户此keepalive内收视状态（0为空闲，

18、1为点播，2为直播，3为点播+直播,4回看）systemInfo YBean系统信息ssid YString无线热点的SSID workIdYString无线热点的信道个数gateway YString当前局域网网关地址dns YString当前局域网DNS地址linkSpeed YString无线热点的带宽aessMethod N*String网络接入方式（“0”为wifi,”1”为有线,”2”为PPPOE）wirelessSignalStrength Y*String无线信号强度（单位微伏db）gatewayMac YString网关mac6.2.2.PERIODIC响应消息方向软探针监控

19、平台软探针（监控数据）消息格式如下Server服务器软件信息Content-Typeapplication/json Content-Length消息体长度消息体中包含一个json文档，具体信息如下S/1.1200OK Server:QB-12表6-4PERIODIC响应payload信息名称Nullable类型含义result Int执行结果exit String是否上报数据0-继续上报，1-停止上报keepalivePeriodic NStringkeepalive定期上报事件间隔（默认值:10*60*1000毫秒）alarmCaptureEn NString是否需要上传抓包文件（默认值:

20、0）0不抓取，1抓取，filterRule NString过滤规则capFileName YString本次上传的抓包文件的名称（例xx07101532-55_sn.pcap）ftpServerAddr YString抓包文件上传的FTP服务器地址ftpUser YString ftp服务器登录用户名ftpPasswd YString ftp服务器登录密码startSecondMonitor YString是否立即开启秒级监控，0不开启，1开启，secondMonitor YString秒级监控上报时间间隔，单位毫秒6.3.PROGRAM INFO接口（IF3）6.3.1.PROGRAM IN

21、FO请求消息方向软探针（收视数据）POST/1.1Host:QB-13Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型消息体中包含一个json文档，具体信息如下表6-5PROGRAM INFO请求payload信息名称Nullable类型含义eventType NBean事件类型eventCode Nint事件号（节目信息上报为6）subEvent Yint子事件号（见1.7.4）actualTime NLong同PERIODIC的actualTime字段deviceInfo NBean设备信息deviceId NString终端序列号（即STB ID）imsi YStri

22、ng IMSIcpu NString CPU型号version NString Android系统版本号release NString机顶盒固件版本model NString机顶盒型号manufacturer NString机顶盒厂家baseParameterList NBean参数version NString软探针中间件版本号interfaceVersion NString接口协议版本号systemInfo YBean系统信息ssid YString无线热点的SSID workIdYString无线热点的信道个数gateway YString当前局域网网关地址dns YString当前局域

23、网DNS地址linkSpeed YString无线热点的带宽aessMethod N*String网络接入方式（“0”为wifi,”1”为有线,”2”为PPPOE）wirelessSignalStrength Y*String无线信号强度（单位微伏db）gatewayMac YString网关mac cpInfo YBean牌照方信息cpName YString牌照方名字，由平台下发，如GITV，TV，WASU等stutterInfo YBean卡顿信息stutterAllTime YString本次keepalive内卡顿总时长（单位毫秒）stutterAllCnt YString本次kee

24、palive内卡顿总次数multisetVodInfo Bean视频参数列表vodUrl Y*String收看节目URL programIdYString取开始收看此节目时的相对时间-系统时间（1970-01-0100:00），转化为平台时间QB-14playtime Y*String节目观看时长（单位毫秒）avgMediaRate NString节目平均码率（文件大小/播放时长或从播放器获取）firstBufferTime Y*String首次加载时长（单位毫秒）bufferTime Y*String节目从开始播放时起缓冲总时长（单位毫秒）avgTimeRemain YString播放器剩余

25、可播放时间平均值（单位:毫秒）maxTimeRemain YString播放器剩余可播放时间最大值（单位:毫秒）minTimeRemain YString播放器剩余可播放时间最小值（单位:毫秒）rebufferFrequency Y*String节目从开始播放时起缓冲次数（单位次）avgDownloadThroughput Y*String节目下载速度平均值（单位bps）maxDownloadThroughput Y*String节目下载速度最大值（单位bps）minDownloadThroughput Y*String节目下载速度最小值（单位bps）avgTcpretran NString

26、TCP平均重传率maxTcpretran NString TCP最大重传率m3u8List NList of Bean所请求的m3u8信息统计（以对应服务器地址为维度）m3u8Addr NString所请求的m3u8对应服务器地址m3u8ReqCnt YString m3u8文件请求总次数m3u8ReqTimeoutCnt YString m3u8文件请求响应超时次数m3u8ReqErrCnt YString m3u8文件请求响应错误次数m3u8ReqNonresponseCnt YString m3u8文件请求无响应次数m3u8ReqContentErrCnt YString m3u8文件请求响应内容错误次数a