查询异常事件用户分布 - ListRtcAbnormalEventDimension
功能介绍
查询指定APP下指定时间内的通话异常明细数据分布情况。
最大查询跨度1天。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/rtc/data/abnormal-event/dimension
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
app | 是 | String | 应用ID |
room_id | 否 | String | 房间ID |
dimension | 否 | String | 分组类型,支持同时指定两种类型
|
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,不填写则默认为当前时间。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
X-Request-Id | String | 请求的唯一标识 |
参数 | 参数类型 | 描述 |
|---|---|---|
dimensions | Array of AbnormalEventDimensionValue objects | 异常体验列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
abnormal_type | Integer | 异常类型:
|
abnormal_type_desc | String | 异常类型描述与异常类型对应,支持国际化,取值范围为:
|
abnormal_factor | Integer | 异常因素 当异常类型为1时,异常因素取值范围为:
当异常类型为2或者3时,异常因素取值范围为:
|
abnormal_factor_desc | String | 异常因素描述,支持国际化 当异常类型为1时,异常因素描述与异常因素对应,取值范围为:
当异常类型为2或者3时,异常因素描述与异常因素对应,取值范围为:
其他情况,异常因素描述为:其他 |
user_count | Long | 异常影响的用户数 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
X-Request-Id | String | 请求的唯一标识 |
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
GET /v1/rtc/data/abnormal-event/dimension?app=5f963b4c89ae1628c2568001&room_id=3b48d9db05cc11ecb1e78fe304a40b8f&start_time=2021-08-25T16:00:00Z&end_time=2021-08-25T18:00:00Z
响应示例
状态码:200
查询成功返回。
{
"dimensions" : [ {
"abnormal_type" : 2,
"abnormal_type_desc" : "视频卡顿",
"abnormal_factor" : 14,
"abnormal_factor_desc" : "下行视频丢包",
"user_count" : 1
}, {
"abnormal_type" : 3,
"abnormal_type_desc" : "音频卡顿",
"abnormal_factor" : 13,
"abnormal_factor_desc" : "下行音频丢包",
"user_count" : 1
} ]
} 状态码:400
查询失败返回
{
"error_code" : "DATA.100011001",
"error_msg" : "Required String parameter 'app' is not present"
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询成功返回。 |
400 | 查询失败返回 |
错误码
请参见错误码。

