机顶盒软探针与监控平台的接口协议规范征求意见版Word下载.docx
《机顶盒软探针与监控平台的接口协议规范征求意见版Word下载.docx》由会员分享，可在线阅读，更多相关《机顶盒软探针与监控平台的接口协议规范征求意见版Word下载.docx（13页珍藏版）》请在冰点文库上搜索。
”value1”,”para2”,”value2”}ListofString的数据格式为“listName”:
[“value1”,”value2”]ListofBean的数据格式为“listName”:
[{“para1”:
”value1”,”para2”:
”value2”},{“para1”:
”value2”}]目前，后台端采用标准的json解析库来解析数据；
机顶盒端通过字符串匹配的方式来解析数据。
6.1.BOOT接口（IF1）6.1.1.BOOT请求消息方向软探针（启动数据）—>
软探针监控平台消息格式如下RequestURI默认为“/”Host软探针监控平台的域名及端口Content-Typeapplication/jsonContent-Length表明了消息体长度；
User-Agent表明了客户端的信息；
Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型POST/1.1Host:
Content-Type:
Content-Length:
User-Agent:
Date:
Aept:
Referrer:
QB-╳╳-╳╳╳-╳╳╳╳5消息体中包含一个json文档，具体信息如下表6-1BOOT请求payload信息名称Nullable类型含义eventTypeNBean事件类型eventCodeNInt事件号subEventYInt子事件号（这里无效）timeOffsetNInt距离该条记录正确上报时间点的时间偏移量，正常上报为0，上报由于其他时间导致延迟1分钟，上报值为60，单位为秒deviceInfoNBean设备信息deviceIdNString终端序列号（即STBID）imsiYStringIMSIcpuNStringCPU型号versionNStringAndroid系统版本号releaseNString机顶盒固件版本modelNString机顶盒型号manufacturerNString机顶盒厂家baseParameterListNBean参数versionNString软探针中间件版本号interfaceVersionNString接口协议版本号wifiProtocolNString路由器的wifi的协议版本，802.11a/g/b/n/ac，具体实现待调研lastRuntimeInfoYBean机顶盒上次运行信息lastStartMomentYString机顶盒上次开机的时间（1970-01-0100:
00:
00）lastRunTimeYString机顶盒上次运行时长cpInfoYBean牌照方信息cpNameYString牌照方名字，由平台下发，如GITV，TV，WASU等systemInfoBean系统信息ssidYString无线热点的SSIDworkIdYString无线热点的信道个数gatewayYString当前局域网网关地址dnsYString当前局域网DNS地址linkSpeedYString无线热点的带宽（单位Mbps）aessMethodN*String网络接入方式（“0”为wifi,“1”为有线,“2”为PPPOE）wirelessSignalStrengthY*String无线信号强度（单位微伏db）gatewayMacYString网关mac样例如下{QB-╳╳-╳╳╳-╳╳╳╳6"
eventType"
:
{"
eventCode"
"
1"
"
subEvent"
0"
},"
deviceInfo"
deviceId"
xx0808"
//终端序列号"
romInfo"
1.0.0"
baseParameterList"
version"
1.00.00.01"
interfaceVersion"
connectionURL"
221.226.67.42:
13852"
//可为空，秒级用（备用接口）},"
hopsIp"
{172.16.34.254,*,221.226.67.41,*,221.231.191.169}"
systemInfo"
aessMethod"
wirelessSignalStrength"
-30.0"
//单位db"
gatewayMac"
00"
}}6.1.2.BOOT响应消息方向软探针监控平台—>
软探针（启动数据）消息格式如下Server服务器软件信息S/1.1200OKServer:
Expires:
QB-╳╳-╳╳╳-╳╳╳╳7Content-Typeapplication/jsonContent-Length消息体长度消息体中包含一个json文档，具体信息如下表6-2BOOT响应payload信息名称单位Nullable类型含义timeStamp毫秒String服务器的当前相对时间（1970-01-0100:
00）configParameterListBean需要设置的参数keepalivePeriodic毫秒NStringkeepalive定期上报事件间隔（默认值:
10*60*1000毫秒）programInfoPeriodic毫秒NString节目播放后，节目信息定期记录的间隔（默认值:
10*60*1000毫秒）。
epgRespThreshold毫秒NStringEPG请求响应时长告警阈值（默认值:
6000）vodRespThresholdNString媒体文件播放失败告警（MediaPlayer的onError事件）m3u8RespThreshold毫秒NStringm3u8请求响应时长告警阈值（默认值:
800）tsRespThreshold毫秒NStringts请求响应时长告警阈值（默认值:
800）exitNString是否上报数据0---继续上报，1---停止上报stutterThresholdX毫秒内卡顿Y次或者单次卡顿时长超过Z毫秒NString卡顿告警阈值（根据总次数、总时长、最长卡顿时长等确定。
参考标准为120*1000毫秒内卡顿总时长15000毫秒，单次最长5000毫秒）如默认120000毫秒内卡顿总次数为10次或者累计卡顿总时长超过15000毫秒或者单次卡顿时长超过5000毫秒（120000,10,15000,5000），不需要的下发值赋-1cpInfoListNListofBean牌照方相关信息cpNameNString牌照方包括GITV（银河），TV（未来电视），WASU（视频基地华数）cpAppNameListNString某个牌照方应用对应的包名列表，如银河为{"
.galaxyitv.launcher"
.galaxyitv.video"
.gitv.tv.live"
.gitv.tv.launcher"
.gitv.launcher"
}，使用逗号分割开cpEpgIPListNString某个牌照方对应的EPG的ip地址列QB-╳╳-╳╳╳-╳╳╳╳8表，使用逗号分割开alarmCaptureEnNString是否需要上传抓包文件（默认值:
0）0不抓取，1抓取captureEnNString是否立即抓取（默认值:
0）0不抓取，1开始抓取，2停止抓取filterRuleNString过滤规则ftpServerAddrYString抓包文件上传的FTP服务器地址ftpUserYStringftp服务器登录用户名ftpPasswdYStringftp服务器登录密码startSecondMonitorYString是否立即开启秒级监控，0不开启，1开启，2，停止样例如下{"
configParameterList"
underThresholdPercentage"
12"
keepalivePeriodic"
10"
//单位为分钟"
programInfoPeriodic"
20"
epgResponseThreshold"
6000"
//单位为ms"
vodResponseThreshold"
800"
m3u8ResponseThreshold"
exit"
//1为强制退出QosMon"
captureEn"
//需要qosmon上传抓包文件"
ftpServerAddr"
172.16.34.200"
ftpUser"
test"
ftpPasswd"
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,此处填测速服务器地址“testTime”:
””,//如果subEvent为52，此处填测速时间（单位:
秒）“protocolType”:
”1”,“port”:
“”}}6.2.PERIODIC接口（IF2）6.2.1.PERIODIC请求消息方向软探针（监控数据）—>
软探针监控平台消息格式如下RequestURI默认为“/”Host软探针监控平台的域名及端口Content-Typeapplication/jsonPOST/1.1Host:
QB-╳╳-╳╳╳-╳╳╳╳10Content-Length表明了消息体长度；
Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型消息体中包含一个json文档，具体信息如下表6-3PERIODIC请求payload信息名称Nullable类型含义eventTypeNBean事件类型eventCodeNint事件号subEventYint子事件号actualTimeNLong事件发生的服务器时间，单位为毫秒，与boot返回字段timeStamp格式一致deviceInfoNBean设备信息deviceIdNString终端序列号（即STBID）imsiYStringIMSIcpuNStringCPU型号versionNStringAndroid系统版本号releaseNString机顶盒固件版本modelNString机顶盒型号manufacturerNString机顶盒厂家baseParameterListNBean参数VersionNString软探针中间件版本号interfaceVersionNString接口协议版本号stutterInfoYBean卡顿信息stutterAllTimeYString本次keepalive内卡顿总时长（单位毫秒）stutterAllCntYString本次keepalive内卡顿总次数cpInfoNBean牌照方信息cpNameYString牌照方名字，由平台下发，如GITV，TV，WASU等appLiveNString牌照方应用是否在运行（“0”为未运行，“1”在运行）m3u8InfoNBean所请求的m3u8信息统计m3u8ReqCntYStringm3u8文件请求总次数m3u8ReqReachCntYStringm3u8文件请求成功次数avgM3u8SessionCostYStringm3u8文件请求响应平均延时（单位毫秒）tsInfoNBean请求的媒体文件请求信息统计tsReqCntYString媒体文件请求总次数tsReqReachCntYString媒体文件请求成功次数QB-╳╳-╳╳╳-╳╳╳╳11avgTsSessionCostYString媒体文件请求响应平均延时（单位毫秒）epgInfoNBean所请求的epg信息统计epgReqCntYStringepg请求总次数epgReqReachCntY-StringEPG请求成功次数avgEpgSessionCostY-StringEPG请求响应平均时延（单位毫秒）tcpConnectInfoNBean所请求的tcp连接信息统计tcpConnectCntYStringTCP连接总次数tcpConnectReachCntY-StringTCP连接成功次数avgTcpConnectCostY-StringTCP建立连接平均时长（单位毫秒）avgTcpretranNString平均重传率stbPlayingStatusNString用户此keepalive内收视状态（0为空闲，1为点播，2为直播，3为点播+直播,4回看）systemInfoYBean系统信息ssidYString无线热点的SSIDworkIdYString无线热点的信道个数gatewayYString当前局域网网关地址dnsYString当前局域网DNS地址linkSpeedYString无线热点的带宽aessMethodN*String网络接入方式（“0”为wifi,”1”为有线,”2”为PPPOE）wirelessSignalStrengthY*String无线信号强度（单位微伏db）gatewayMacYString网关mac6.2.2.PERIODIC响应消息方向软探针监控平台—>
软探针（监控数据）消息格式如下Server服务器软件信息Content-Typeapplication/jsonContent-Length消息体长度消息体中包含一个json文档，具体信息如下S/1.1200OKServer:
QB-╳╳-╳╳╳-╳╳╳╳12表6-4PERIODIC响应payload信息名称Nullable类型含义resultInt执行结果exitString是否上报数据0---继续上报，1---停止上报keepalivePeriodicNStringkeepalive定期上报事件间隔（默认值:
10*60*1000毫秒）alarmCaptureEnNString是否需要上传抓包文件（默认值:
0）0不抓取，1抓取，filterRuleNString过滤规则capFileNameYString本次上传的抓包文件的名称（例xx07101532-55_sn.pcap）ftpServerAddrYString抓包文件上传的FTP服务器地址ftpUserYStringftp服务器登录用户名ftpPasswdYStringftp服务器登录密码startSecondMonitorYString是否立即开启秒级监控，0不开启，1开启，secondMonitorYString秒级监控上报时间间隔，单位毫秒6.3.PROGRAMINFO接口（IF3）6.3.1.PROGRAMINFO请求消息方向软探针（收视数据）—>
POST/1.1Host:
QB-╳╳-╳╳╳-╳╳╳╳13Date发起请求的日期、时间Aept终端可以接收的响应消息的媒体类型消息体中包含一个json文档，具体信息如下表6-5PROGRAMINFO请求payload信息名称Nullable类型含义eventTypeNBean事件类型eventCodeNint事件号（节目信息上报为6）subEventYint子事件号（见1.7.4）actualTimeNLong同PERIODIC的actualTime字段deviceInfoNBean设备信息deviceIdNString终端序列号（即STBID）imsiYStringIMSIcpuNStringCPU型号versionNStringAndroid系统版本号releaseNString机顶盒固件版本modelNString机顶盒型号manufacturerNString机顶盒厂家baseParameterListNBean参数versionNString软探针中间件版本号interfaceVersionNString接口协议版本号systemInfoYBean系统信息ssidYString无线热点的SSIDworkIdYString无线热点的信道个数gatewayYString当前局域网网关地址dnsYString当前局域网DNS地址linkSpeedYString无线热点的带宽aessMethodN*String网络接入方式（“0”为wifi,”1”为有线,”2”为PPPOE）wirelessSignalStrengthY*String无线信号强度（单位微伏db）gatewayMacYString网关maccpInfoYBean牌照方信息cpNameYString牌照方名字，由平台下发，如GITV，TV，WASU等stutterInfoYBean卡顿信息stutterAllTimeYString本次keepalive内卡顿总时长（单位毫秒）stutterAllCntYString本次keepalive内卡顿总次数multisetVodInfoBean视频参数列表vodUrlY*String收看节目URLprogramIdYString取开始收看此节目时的相对时间--系统时间（1970-01-0100:
00），转化为平台时间QB-╳╳-╳╳╳-╳╳╳╳14playtimeY*String节目观看时长（单位毫秒）avgMediaRateNString节目平均码率（文件大小/播放时长或从播放器获取）firstBufferTimeY*String首次加载时长（单位毫秒）bufferTimeY*String节目从开始播放时起缓冲总时长（单位毫秒）avgTimeRemainYString播放器剩余可播放时间平均值（单位:
毫秒）maxTimeRemainYString播放器剩余可播放时间最大值（单位:
毫秒）minTimeRemainYString播放器剩余可播放时间最小值（单位:
毫秒）rebufferFrequencyY*String节目从开始播放时起缓冲次数（单位次）avgDownloadThroughputY*String节目下载速度平均值（单位bps）maxDownloadThroughputY*String节目下载速度最大值（单位bps）minDownloadThroughputY*String节目下载速度最小值（单位bps）avgTcpretranNStringTCP平均重传率maxTcpretranNStringTCP最大重传率m3u8ListNListofBean所请求的m3u8信息统计（以对应服务器地址为维度）m3u8AddrNString所请求的m3u8对应服务器地址m3u8ReqCntYStringm3u8文件请求总次数m3u8ReqTimeoutCntYStringm3u8文件请求响应超时次数m3u8ReqErrCntYStringm3u8文件请求响应错误次数m3u8ReqNonresponseCntYStringm3u8文件请求无响应次数m3u8ReqContentErrCntYStringm3u8文件请求响应内容错误次数a
升级会员 