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

查询流量数据分布

功能介绍

查询RTC的各维度的流量。

最大查询跨度1天。

接口约束

查询流量数据分布

调试

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

URI

GET /v1/rtc/data/stats/traffic/dimension

表1 Query参数

参数

是否必选

参数类型

描述

app

是

String

应用id

start_time

是

String

查询起始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ，如2020-04-23T07:00:00Z 。开始和结束最大跨度1天。

end_time

是

String

查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ，如2020-04-23T07:00:00Z 。开始和结束最大跨度1天。

dimension

是

String

查询分组类型，取值如下：

node: 节点维度

host：设备维度

dest_type

否

Integer

查询的对端类型，取值如下:

0: 终端

1: 服务端

direction

否

String

查询音视频流量方向，取值如下：

up: 上行流量

down: 下行流量

type

否

Array of strings

查询流的类型，取值如下：

video: 视频

audio: 音频

aux: 辅流

node_name

否

Array of strings

需查询的节点，最大10个

host_name

否

Array of strings

需查询的节点，最大10个

interval

否

Integer

返回的数据点时间间隔，单位分钟，取值如下：

60 ：1分钟粒度

300 ：5分钟粒度

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识
表4 响应Body参数

参数

参数类型

描述

traffic

Array of TrafficDimensionTimeValue objects

时间戳及相应时间的指标数值
表5 TrafficDimensionTimeValue

参数

参数类型

描述

dimension_value

String

维度值。若查询参数dimension=node，则此处返回具体的节点名称若查询参数dimension=host，则此处返回具体的设备名称

data

Array of TimeValueData objects

指定维度值对应的时间戳及相应时间的指标数值
表6 TimeValueData

参数

参数类型

描述

time

String

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

value

Long

查询的流量指标值

状态码： 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码： 200

查询成功返回。

{
  "traffic" : [ {
    "dimension_value" : "603f71bdfa163e500aff1106c8bxxxxx.sparkrtc.myhuaweicloud.com",
    "data" : [ {
      "time" : "2021-04-23T09:55:32Z",
      "value" : 102
    } ]
  } ]
}

状态码： 400

处理失败返回。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: play_domains"
}

状态码

状态码

描述

200

查询成功返回。

400

处理失败返回。

错误码

请参见错误码。

父主题： 数据统计分析

相关文档