文档首页/ 实时音视频 SparkRTC/ API参考/ 数据统计分析/ 实时查询用户服务端的QoS质量数据
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

实时查询用户服务端的QoS质量数据

功能介绍

查询用户维度实时服务端qos指标。

最大查询跨度1天。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/rtc/data/server/qos/details

表1 Query参数

参数

是否必选

参数类型

描述

app

是

String

应用id

room_id

是

String

房间ID

user_id

否

String

用户id

start_time

否

String

用户数据查询开始时间，UTC时间，格式：yyyy-mm-ddThh:mm:ssZ，如2020-04-23T07:00:00Z，

如果未传，数据则取当前指标最新数据

end_time

否

String

用户数据查询结束时间，UTC时间，格式：yyyy-mm-ddThh:mm:ssZ，如2020-04-23T07:00:00Z，

如果未传，数据则取当前指标最新数据

direction

否

String

音视频上下行选择，取值如下：

·up: 音视频上行数据。

·down: 音视频下行数据。

type

否

Array of strings

查询数据类型，取值如下：

video: 视频。

audio: 音频。

aux: 辅流。

mid

是

Array of strings

需查询的指标，填all则返回所有指标。多个使用','分割lostRate 丢包率rtt 环路时延jitter 抖动fps 帧率bps 带宽bytes 字节数pktCnt 包数lostPktCnt 丢包数volumeL1 音量值0-60的个数volumeL2 音量值61-100的个数volumeL3 音量值101-127的个数picW 分辨率的宽(只有视频和辅流生效)picH 分辨率的高(只有视频和辅流生效)codec 编码格式，当前固定音频为opus，视频和辅流为H264

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识
表4 响应Body参数

参数

参数类型

描述

room_id

String

房间ID

data

Array of RtcQosQualityData objects

QoS质量数据
表5 RtcQosQualityData

参数

参数类型

描述

uid

String

用户id

stream_no

String

流号

mid

String

指标ID

direction

String

up上行数据 down下行数据

type

String

类型

data

Array of TimeObjectValueData objects

时间戳及相应时间的指标数值
表6 TimeObjectValueData

参数

参数类型

描述

time

String

采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ

value

Integer

当前时间返回参数取值

状态码： 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

查询成功返回。

{
  "room_id" : "ac146d0f27799161917160702xxxxx",
  "data" : [ {
    "uid" : "xxxx",
    "stream_no" : "603f71bdfa163e500aff1106c8xxxxx",
    "mid" : "iphone",
    "direction" : "xxx",
    "type" : "xxx",
    "data" : [ {
      "time" : "2021-04-23T09:55:32Z",
      "value" : 200
    } ]
  } ]
}

状态码： 400

处理失败返回。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: play_domains"
}

状态码

状态码

描述

200

查询成功返回。

400

处理失败返回。

错误码

请参见错误码。

父主题： 数据统计分析

相关文档