文档首页/实时音视频 SparkRTC/API参考/数据统计分析/查询用户通话指标 - ListRtcClientQosDetails
更新时间：2025-11-04 GMT+08:00
查看PDF
分享

查询用户通话指标 - ListRtcClientQosDetails

功能介绍

查询用户通话质量指标数据。

可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/rtc/client/qos/details

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

domain

否

String

域名

app_id

是

String

应用id

room_id

是

String

房间ID

user_id

否

String

发送端用户

peer_id

否

String

需查询接收端用户id

stream_id

否

String

流号

direction

否

String

判断上下行数据

mid

是

Array of strings

需查询的指标，填all则返回所有指标。多个指标使用','分割

  • appcpu：端侧APP CPU使用率（appCpu）

  • syscpu：端侧系统 CPU使用率（deviceCpu）

  • abit：端侧音频码率kpbs（bitrate）

  • vbit：端侧视频码率kbps（bitRate）

  • dbit：端侧辅流码率kbps（bitRate）

  • vfps：端侧视频帧率fps（actFrameRate）

  • dfps：端侧辅流帧率fps（actFrameRate）

  • vblock：端侧视频卡顿率（统计大于等于600ms视频卡顿）

  • dblock：端侧辅流卡顿率（统计大于等于600ms辅流卡顿）

  • aloss：端侧音频丢包率（pktLoss）

  • vloss：端侧视频丢包率（pktLoss）

  • dloss：端侧辅流丢包率（pktLoss）

  • vwidth：端侧视频分辨率宽（actPicW）

  • vheight：端侧视频分辨率高（actPicH）

  • dwidth：端侧辅流分辨率宽（actPicW）

  • dheight：端侧辅流分辨率高（actPicH）

  • ajitter：端侧音频抖动率（jitter）

  • artt：端侧音频时延（rtt）

  • vjitter：端侧视频抖动率（jitter）

  • vrtt：端侧视频时延（rtt）

  • djitter：端侧辅流抖动率（jitter）

  • drtt：端侧辅流时延（rtt）

start_time

是

String

查询起始时间。UTC时间，格式：yyyy-mm-ddThh:mm:ssZ，如2020-04-23T06:00:00Z

end_time

是

String

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

time_type

否

String

查询的时间类型取值：stime 数据库打点时间，不填默认ctime查询

limit

否

Integer

查询结果限制

offset

否

Integer

查询偏移量

请求参数

表3 请求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

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识

表5 响应Body参数

参数

参数类型

描述

room_id

String

房间ID

data

Array of QosQualityData objects

QoS质量数据

表6 QosQualityData

参数

参数类型

描述

uid

String

用户id

peerid

String

对端的用户ID，为0时表示本端上行数据

mid

String

指标ID

data

Array of TimeFloatValueData objects

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

表7 TimeFloatValueData

参数

参数类型

描述

time

String

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

value

Float

当前时间返回参数取值

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v1/{project_id}/rtc/client/qos/details?app_id=5fa682b34a974f7ad24d223b&room_id=6951a79e9f811ebbd2ac58d7ac82553&mid=appcpu&start_time=2020-04-23T06:00:00Z&end_time=2020-04-23T07:00:00Z

响应示例

状态码：200

查询成功返回。

{
  "room_id" : "73594089618272256",
  "data" : [ {
    "uid" : "30617",
    "peerid" : "30617",
    "mid" : "ajitter",
    "data" : [ {
      "time" : "2022-06-04T06:06:00Z",
      "value" : 433422
    }, {
      "time" : "2022-06-04T06:00:05Z",
      "value" : 433422
    } ]
  } ]
}

状态码：400

查询失败返回

{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app_id' is not present"
}

状态码

状态码

描述

200

查询成功返回。

400

查询失败返回

错误码

请参见错误码。

父主题：数据统计分析