文档首页/ 实时音视频 SparkRTC/ API参考/ 数据统计分析/ 查询用户异常体验事件
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

查询用户异常体验事件

功能介绍

查询指定APP下通话的异常明细数据。

最大查询跨度1天。

调试

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

URI

GET /v1/rtc/data/abnormal-events

表1 Query参数

参数

是否必选

参数类型

描述

app

是

String

应用ID

room_id

否

String

房间ID

uid

否

String

用户ID

start_time

否

String

查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不填写则默认读取过去1小时数据数据。

end_time

否

String

查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z，不填写则默认为当前时间。

limit

否

Integer

查询结果条数，默认值为10

offset

否

Integer

查询偏移量，默认值为0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

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

参数

参数类型

描述

total

Integer

异常总数

events

Array of AbnormalEvent objects

异常体验列表
表5 AbnormalEvent

参数

参数类型

描述

time

String

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

uid

String

出现异常的用户ID

room_id

String

出现异常的房间ID

stage

String

出现异常的环节

  • join_room：加入房间

  • communication：通话中

location

String

事件发生位置

  • local：事件发生在客户端本地

  • remote：事件发生在远端

peer_uid

String

如果根因来自远端用户，则peerid为远端用户的用户ID。如果根因来自自身，则peerid为空字符串

abnormal_type

Integer

异常类型：

  • 1：进房慢(5s加入房间失败)

  • 2：视频卡顿

  • 3：音频卡顿

abnormal_type_desc

String

异常类型描述与异常类型对应，支持国际化，取值范围为：

  • 进房慢(5s加入房间失败)

  • 视频卡顿

  • 音频卡顿

abnormal_factor

Integer

异常因素

当异常类型为1时，异常因素取值范围为：

  • 1：建链失败

  • 2：房间非空闲

  • 3：服务器异常

  • 4：服务器反馈503

  • 5：鉴权失败

  • 6：鉴权重试

  • 7：时钟同步失败

  • 8：url错误

  • 9：终端内部异常

  • 90000004：SDK发出的加入房间信令响应超时

  • 90100009：web侧没有收到MSP下发的配置信息

  • 90100008：websocket链路建链失败

  • 10000001：服务侧返回的异常信息

  • 31000003：服务侧返回的异常信息

  • 32000030：服务侧返回的异常信息

  • 15：浏览器设置sdp异常

当异常类型为2或者3时，异常因素取值范围为：

  • 1：系统CPU占用高

  • 2：App CPU占用高

  • 3：音频上行网络延时

  • 4：音频上行网络抖动

  • 5：视频上行网络延时

  • 6：视频上行网络抖动

  • 7：音频下行网络延时

  • 8：音频下行网络抖动

  • 9：视频下行网络延时

  • 10：视频下行网络抖动

  • 11：上行音频丢包

  • 12：上行视频丢包

  • 13：下行音频丢包

  • 14：下行视频丢包

  • 15：下行音频无声音

  • 16：其他

  • 17：对端用户离线

  • 18：对端用户无码流

  • 19：对端用户无帧率

  • 20：本端服务器下行无码流

  • 21：本端服务器下行无帧率

abnormal_factor_desc

String

异常因素描述，支持国际化

当异常类型为1时，异常因素描述与异常因素对应，取值范围为：

  • 建链失败

  • 房间非空闲

  • 服务器异常

  • 服务器反馈503

  • 鉴权失败

  • 鉴权重试

  • 时钟同步失败

  • url错误

  • 终端内部异常

  • SDK发出的加入房间信令响应超时

  • web侧没有收到MSP下发的配置信息

  • websocket链路建链失败

  • 服务侧返回的异常信息

  • 服务侧返回的异常信息

  • 服务侧返回的异常信息

  • 浏览器设置sdp异常

当异常类型为2或者3时，异常因素描述与异常因素对应，取值范围为：

  • 系统CPU占用高

  • App CPU占用高

  • 音频上行网络延时

  • 音频上行网络抖动

  • 视频上行网络延时

  • 视频上行网络抖动

  • 音频下行网络延时

  • 音频下行网络抖动

  • 视频下行网络延时

  • 视频下行网络抖动

  • 上行音频丢包

  • 上行视频丢包

  • 下行音频丢包

  • 下行视频丢包

  • 下行音频无声音

  • 其他

  • 对端用户离线

  • 对端用户无码流

  • 对端用户无帧率

  • 本端服务器下行无码流

  • 本端服务器下行无帧率

其他情况，异常因素描述为：其他

状态码： 400

表6 响应Header参数

参数

参数类型

描述

X-Request-Id

String

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

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v1/rtc/data/abnormal-events?app=5f963b4c89ae1628c2568001&room_id=3b48d9db05cc11ecb1e78fe304a40b8f&start_time=2021-08-25T16:00:00Z&end_time=2021-08-25T18:00:00Z

响应示例

状态码： 200

查询成功返回。

{
  "total" : 2,
  "events" : [ {
    "time" : "2021-08-25T17:45:00Z",
    "uid" : "3d00ea7405cc11eca3b919d9aaa81457",
    "room_id" : "3b48d9db05cc11ecb1e78fe304a40b8f",
    "stage" : "communication",
    "location" : "remote",
    "peer_uid" : "3cc0863505cc11eca3b9cb30b1856de8",
    "abnormal_type" : 3,
    "abnormal_type_desc" : "音频卡顿",
    "abnormal_factor" : 13,
    "abnormal_factor_desc" : "下行音频丢包"
  }, {
    "time" : "2021-08-25T17:45:00Z",
    "uid" : "3d00ea7405cc11eca3b919d9aaa81457",
    "room_id" : "3b48d9db05cc11ecb1e78fe304a40b8f",
    "stage" : "communication",
    "location" : "remote",
    "peer_uid" : "3cc0863505cc11eca3b9cb30b1856de8",
    "abnormal_type" : 2,
    "abnormal_type_desc" : "视频卡顿",
    "abnormal_factor" : 14,
    "abnormal_factor_desc" : "下行视频丢包"
  } ]
}

状态码： 400

查询失败返回

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

状态码

状态码

描述

200

查询成功返回。

400

查询失败返回

错误码

请参见错误码。

父主题： 数据统计分析

相关文档