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

查询指定项目用户异常体验事件

功能介绍

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

调试

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

URI

GET /v1/{project_id}/rtc/client/abnormalevent

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

app_id

String

应用id

room_id

String

房间id

start_time

String

起始时间。UTC时间,格式:yyyy-mm-ddThh:mm:ssZ,如2020-04-23T06:00:00Z。查询起止时间不超过1个小时,每次查询单个用户时,支持跨天查询,最长5天。

end_time

String

结束时间。UTC时间,格式:yyyy-mm-ddThh:mm:ssZ,如2020-04-23T06:00:00Z。查询起止时间不超过1个小时,每次查询单个用户时,支持跨天查询,最长5天。

请求参数

表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

uid

String

用户ID

exp_id

String

体验ID

abnormal_list

Array of RTCCause objects

异常信息列表。注意:此字段可能返回null,表示取不到有效值。

表6 RTCCause

参数

参数类型

描述

ts

String

异常事件的时间戳

event_id

String

异常事件ID

peer_id

String

对端的用户ID

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码: 200

查询成功返回。

{
  "uid" : "sfu-PLAYER-18708-2-1",
  "room_id" : "ddmax1000-2",
  "exp_id" : "954350051",
  "abnormal_list" : [ {
    "event_id" : "18",
    "peer_id" : "w138",
    "ts" : "2020-04-23T08:00:00Z"
  } ]
}

状态码: 400

查询失败返回

{
  "error_code" : "400",
  "error_msg" : "Invalid request parameter: play_domains"
}

状态码

状态码

描述

200

查询成功返回。

400

查询失败返回

错误码

请参见错误码

相关文档