查询历史规模
功能介绍
查询指标过去每天的规模数量，可查询最近31天的数据。当天未结束，无法查到当天的房间数与用户数。
最大查询跨度31天。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/rtc/history/scale
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app |
是 |
String |
应用标识 |
|
metric |
是 |
Array of strings |
查询的数据类型
|
|
start_date |
否 |
String |
查询起始时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23，不写默认读取过去1天数据。 |
|
end_date |
否 |
String |
查询结束时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
请求的唯一标识 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
scale |
Array of RtcHistoryScaleTimeValue objects |
时间戳及相应时间的指标数值列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
date |
String |
采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DD |
|
user_count |
Long |
通话人数，指总的uid个数 |
|
session_count |
Long |
通话人次，指总的session个数 |
|
room_count |
Long |
房间数 |
|
max_online_user_count |
Long |
最大同时在线人数 |
|
max_online_room_count |
Long |
最大同时在线房间数 |
|
communication_duration |
Long |
音视频通话总时长，单位秒 |
|
video_communication_duration |
Long |
视频通话总时长，单位秒 |
|
audio_communication_duration |
Long |
音频通话总时长，单位秒 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET /v1/{project_id}/rtc/history/scale?app=5fa682b34a974f7ad24d223b&metric=SessionCount,MaxOnlineRoomCount&start_date=2020-04-23&end_date=2020-04-26
响应示例
状态码： 200
查询成功返回。
{
"scale" : [ {
"date" : "2020-06-04",
"user_count" : 1,
"session_count" : 1,
"room_count" : 3,
"max_online_user_count" : 5,
"max_online_room_count" : 4,
"communication_duration" : 123,
"video_communication_duration" : 234,
"audio_communication_duration" : 132
} ]
}
状态码： 400
查询失败返回
{
"error_code" : "DATA.100011001",
"error_msg" : "Required String parameter 'app' is not present"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功返回。 |
|
400 |
查询失败返回 |
错误码
请参见错误码。
