文档首页/ 实时音视频 SparkRTC/ API参考/ 数据统计分析/ 查询实时网络
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

查询实时网络

功能介绍

获取实时网络数据相关指标在某一时间段内每分钟的统计数据。

最大查询跨度1天。

URI

GET /v1/{project_id}/rtc/realtime/network

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

app

是

String

应用标识

room_id

否

String

房间ID

metric

是

String

查询的数据类型：

  • VideoUpstreamExcellentTransRate：客户端视频上行优质传输率

  • AudioUpstreamExcellentTransRate：客户端音频上行优质传输率

  • VideoExcellentTransRate：端到端视频优质传输率

  • AudioExcellentTransRate：端到端音频优质传输率

sdk_type

是

String

sdk类型

  • native：非web版sdk;

  • webrtc：web版sdk;

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-23T06:00:00Z，不写默认为当前时间。

请求参数

表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参数

参数

参数类型

描述

network

Array of TimeDoubleValueData objects

时间戳及相应时间的指标数值列表
表6 TimeDoubleValueData

参数

参数类型

描述

time

String

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

value

Double

当前时间返回参数取值

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v1/{project_id}/rtc/realtime/network?app=5fa682b34a974f7ad24d223b

响应示例

状态码： 200

查询成功返回。

{
  "network" : [ {
    "time" : "2020-06-04T07:00:00Z",
    "value" : 0
  } ]
}

状态码： 400

查询失败返回

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

状态码

状态码

描述

200

查询成功返回。

400

查询失败返回

错误码

请参见错误码。

父主题： 数据统计分析