获取实时运营数据 ListRealTimeOperationData--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取实时运营数据 ListRealTimeOperationData

最近更新时间：2024.02.29 19:30:24首次发布时间：2022.08.03 14:33:59

你可以使用此接口查询一段时间内，某个应用的音视频通话实时运营数据。

使用说明

接口行为

可以调用 ListRealTimeOperationData 接口，指定你所属的 AppId，指标类型和查询时间段，查询该时间段内指标的数据。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

最大请求次数：2 次/秒
最远可查询时间：60 分钟
最大单次查询时间跨度：60 分钟
数据延迟：20 秒

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志。
StartTime	String	是	`2021-07-24T00:00:00+08:00`	查询起始时间戳，格式为 RFC3339，单位为秒。
EndTime	String	是	`2021-07-24T00:01:00+08:00`	查询结束时间戳，格式为 RFC3339，单位为秒。
Indicator	String[]	是	`["online_user_count","online_room_count"]`	查询的指标名称。可同时查询多个指标。 Indicator 可选值，参看实时运营数据相关 indicator。

返回参数

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

参数	类型	示例值	描述
Indicators	Object[]	`-`	具体指标数据
Name	String	`5s_join_room_success_rate`	指标名称
Unit	String	`%`
Data	Object[]		具体的指标值以及对应时间
Value	Double	`99.99`	指标值，浮点数，保留两位小数。指标值，浮点数，保留两位小数。
TimeStamp	String	`2021-07-24T00:00:00+08:00`	指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
overview	Object
Name	String		指标名
Unit	String		单位
Alias	String		指标中文名
Value	String		值
MaxValue	String
MinValue	String
ExtraInfo	String
HoverInfo	String		hover时提醒信息

请求示例

POST https://rtc.volcengineapi.com?Action=ListRealTimeOperationData&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "StartTime": "2021-07-24T00:00:00+08:00",
    "EndTime": "2021-07-24T00:01:00+08:00",
    "Indicator": [
        "online_user_count",
        "online_room_count"
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "ListRealTimeOperationData",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": {
    "Indicators": [
      {
        "Name": "online_user_count",
        "Data": [
          {
            "TimeStamp": "2021-07-24T00:00:00+08:00",
            "Value": 3212
          },
          {
            "TimeStamp": "2021-07-24T00:00:30+08:00",
            "Value": 3211
          },
          {
            "TimeStamp": "2021-07-24T00:01:00+08:00",
            "Value": 3210
          }
        ]
      },
      {
        "Name": "online_room_count",
        "Data": [
          {
            "TimeStamp": "2021-07-24T00:00:00+08:00",
            "Value": 1231
          },
          {
            "TimeStamp": "2021-07-24T00:00:30+08:00",
            "Value": 1232
          },
          {
            "TimeStamp": "2021-07-24T00:01:00+08:00",
            "Value": 1233
          }
        ]
      }
    ]
  }
}

错误码

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