查询用户通话指标
功能介绍
查询用户通话质量指标数据。
可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。
URI
GET /v1/{project_id}/rtc/client/qos/details
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
否 |
String |
域名 |
app_id |
是 |
String |
应用id |
room_id |
是 |
String |
房间ID |
user_id |
否 |
String |
发送端用户 |
peer_id |
否 |
String |
需查询接收端用户id |
stream_id |
否 |
String |
流号 |
direction |
否 |
String |
判断上下行数据 |
mid |
是 |
Array |
需查询的指标,填all则返回所有指标。多个指标使用','分割
|
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 |
查询偏移量 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求的唯一标识 |
参数 |
参数类型 |
描述 |
---|---|---|
room_id |
String |
房间ID |
data |
Array of QosQualityData objects |
QoS质量数据 |
参数 |
参数类型 |
描述 |
---|---|---|
uid |
String |
用户id |
peerid |
String |
对端的用户ID,为0时表示本端上行数据 |
mid |
String |
指标ID |
data |
Array of TimeFloatValueData objects |
时间戳及相应时间的指标数值列表 |
参数 |
参数类型 |
描述 |
---|---|---|
time |
String |
采样时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ |
value |
Float |
当前时间返回参数取值 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
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 |
查询失败返回 |
错误码
请参见错误码。