状态码
状态码 描述
200 查询成功返回。
400 查询失败返回
错误码
请参见错误码。
11.9 查询历史质量
功能介绍
查询质量指标过去每天的体验数据,可查询最近31天的数据。当天未结束,无法查询 到当天的体验数据。
最大查询跨度31天。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/rtc/history/quality
表11-57 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID。
表11-58 Query 参数
参数 是否必选 参数类型 描述
app 是 String 应用标识
API 参考 11 数据统计分析
参数 是否必选 参数类型 描述
metric 是 Array 查询的数据类型
● JoinSuccessRate:加入房间 成功率
● JoinSuccess5SecsRate:5秒 加入成功率
● VideoFreezeRate:视频卡顿 率
● AudioFreezeRate:音频卡顿 率
● FirstVideoRecvTime:首帧 视频接收耗时
● FirstAudioRecvTime:首帧 音频接收耗时
● PullStreamSuccessRate:拉 流成功率
● PushStreamSuccessRate:
推流成功率
● VideoUpstreamExcellentTra nsRate:客户端视频上行优 质传输率
● AudioUpstreamExcellentTra nsRate:客户端音频上行优 质传输率
● VideoExcellentTransRate:
端到端视频优质传输率
● AudioExcellentTransRate:
端到端音频优质传输率
● VideoTransDelay:端到端视 频网络时,单位为毫秒,取 当天所有用户网络延迟的中 位数
● AudioTransDelay:端到端音 频网络时延,单位为毫秒,
取当天所有用户网络延迟的 中位数
start_date 否 String 查询起始时间。UTC时间,格 式:YYYY-MM-DD,如 2020-04-23,不写默认读取过 去1天数据数据。
end_date 否 String 查询结束时间。UTC时间,格 式:YYYY-MM-DD,如 2020-04-23
API 参考 11 数据统计分析
请求参数
表11-59 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token。使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取(响应消 息头中X-Subject-Token的 值)。
Authorization 否 String 使用AK/SK方式认证时必选,携 带的鉴权信息。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请 求的发生时间。
X-Project-Id 否 String 使用AK/SK方式认证时必选,携 带项目ID信息,与路径参数中的 项目ID相同。
响应参数
状态码: 200
表11-60 响应 Header 参数
参数 参数类型 描述
X-request-id String 请求的唯一标识
表11-61 响应 Body 参数
参数 参数类型 描述
quality Array of RtcHistoryQu alityTimeVal ue objects
时间戳及相应时间的指标数值列表
表11-62 RtcHistoryQualityTimeValue
参数 参数类型 描述
date String 采样时间。日期格式按照ISO8601表示法,并使 用UTC时间。格式为YYYY-MM-DD
API 参考 11 数据统计分析
参数 参数类型 描述 join_success_r
ate Double 加入房间成功率参数取值,取值为1代表成功率 100%
join_success_i
n5secs_rate Double 5s内加入房间成功率参数取值,取值为1代表成功 率100%
video_freeze_r
ate Double 视频卡顿率参数取值,取值为1代表卡顿率100%
audio_freeze_
rate Double 音频卡顿率参数取值,取值为1代表卡顿率100%
first_video_rec
v_time Long 首帧视频接收耗时,单位毫秒 first_audio_re
cv_time Long 首帧音频接收耗时,单位毫秒 pull_stream_s
uccess_rate Double 拉流成功率参数取值,取值为1代表成功率100%
push_stream_
success_rate Double 推流成功率参数取值,取值为1代表成功率100%
video_upstrea m_excellent_t rans_rate
Double 客户端视频上行优质传输率,取值为1代表传输率 100%
audio_upstrea m_excellent_t rans_rate
Double 客户端音频上行优质传输率,取值为1代表传输率 100%
video_excellen
t_trans_rate Double 端到端视频优质传输率,取值为1代表传输率 100%
audio_excelle
nt_trans_rate Double 端到端音频优质传输率,取值为1代表传输率 100%
video_trans_d
elay Double 端到端视频网络时延,单位为毫秒,取当天所有 用户网络延迟的中位数。
audio_trans_d
elay Double 端到端音频网络时延,单位为毫秒,取当天所有 用户网络延迟的中位数。
状态码: 400
表11-63 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
API 参考 11 数据统计分析
请求示例
GET /v1/{project_id}/rtc/history/quality?
app=5fa682b34a974f7ad24d223b&metric=VideoFreezeRate,AudioTransDelay&start_date=2020-04-23&end_d ate=2020-04-26
响应示例
状态码: 200 查询成功返回。
{ "quality" : [ {
"date" : "2020-06-04", "join_success_rate" : 0.99 } ]
}
状态码: 400 查询失败返回
{ "error_code" : "DATA.100011001",
"error_msg" : "Required String parameter 'app' is not present"
}
状态码
状态码 描述
200 查询成功返回。
400 查询失败返回
错误码
请参见错误码。