获取实时分布质量数据 ListRealTimeQualityDistribution--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取实时分布质量数据 ListRealTimeQualityDistribution

最近更新时间：2024.06.26 11:46:26首次发布时间：2022.12.16 20:05:32

你可调用此接口查询一段时间内，某个应用的音视频通话在地域分布、设备平台、网络类型等维度的实时质量指标数据。

使用说明

接口行为

调用ListRealTimeQualityDistribution接口，指定 AppId、查询时间、指标名称和指标维度，获取地域分布、设备平台、网络类型等维度的实时质量指标数据。

注意事项

最大请求次数：2 次/秒
可查询时间范围：最近 60 分钟
单次查询时间范围：60 分钟
数据延时：1 分钟

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=ListRealTimeQualityDistribution&Version=2020-12-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRealTimeQualityDistribution`	接口名称。当前 API 的名称为 `ListRealTimeQualityDistribution`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志。
StartTime	String	是	`2022-12-12T14:00:00+08:00`	查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime	String	是	`2022-12-12T14:10:00+08:00`	查询结束时间戳，格式为 RFC3339，单位为秒。
Indicator	String	是	`join_room_success_rate`	查询的指标名称。一次仅支持查询一个指标。`Indicator` 可选值，参看质量数据相关 indicator。
Dimension	String	是	`Province`	查询的维度，一次仅支持查询一个维度。支持设为以下值： Province：一级行政区（包括港澳台地区） Country：国家 OS：用户设备平台包括：`android`、`ios`、`linux`、`mac`、`windows` Access：用户网络类型包括：`2g`、`3g`、`4g`、`5g`、`wifi`
Platform	String	否	`Android`
ProductType	String	否	`native`

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
Indicators	Object[]		具体指标数据
Name	String	`5s_join_room_success_rate`	指标名称
Data	Object[]		具体的指标值以及对应时间
Value	Double	`99.06`	指标数值，保留两位小数。
Dimension	String	`windows`	具体的维度信息。
TimeStamp	String	`2022-12-12T14:00:30+08:00`	指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。

请求示例

POST https://rtc.volcengineapi.com?Action=ListRealTimeQualityDistribution&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "StartTime": "2022-12-12T14:00:00+08:00",
    "EndTime": "2022-12-12T14:01:00+08:00",
    "Indicator": "join_room_success_rate",
    "Dimension": "OS"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "ListRealTimeQualityDistribution",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": {
    "Indicators": [
      {
        "Name": "join_room_success_rate",
        "Data": [
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.05,
            "Dimension": "windows"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.24,
            "Dimension": "ios"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.12,
            "Dimension": "android"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 99.83,
            "Dimension": "mac"
          },
          {
            "Timestamp": "2022-12-12T14:00:00+08:00",
            "Value": 100,
            "Dimension": "linux"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.82,
            "Dimension": "mac"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.49,
            "Dimension": "linux"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 98.98,
            "Dimension": "android"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.15,
            "Dimension": "ios"
          },
          {
            "Timestamp": "2022-12-12T14:00:30+08:00",
            "Value": 99.06,
            "Dimension": "windows"
          }
        ]
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。