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

接口行为

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。

接口限制
限制类别调用频率限制

最大请求次数

  • 10 次/分钟
  • 1440 次/天
最远可查询时间60 分钟
最大单次查询时间跨度60 分钟
数据延迟20 秒
请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是ListRealTimeOperationData接口名称,本接口取值:ListRealTimeOperationData
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdString是Your_AppId你的音视频应用的唯一标志。
StartTimeString是2021-07-24T00:00:00+08:00查询起始时间戳,格式为 RFC3339,单位为秒。
EndTimeString是2021-07-24T00:01:00+08:00查询结束时间戳,格式为 RFC3339,单位为秒。
IndicatorArray of String是["online_user_count","online_room_count"]查询的指标名称。可同时查询多个指标。 Indicator 可选值,参看实时运营数据相关 indicator。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=ListRealTimeOperationData&Version=2020-12-01
postscript
Body
{
    "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"]
}
json
返回调用结果
返回参数说明

返回结果参看 BaseResponse。
其中 Result 的结构如下:

参数名类型描述
IndicatorsArray of Indicator具体指标数据

Indicator

参数名类型示例值描述
Namestringonline_user_count指标名称
DataArray of DataItem具体的指标值以及对应时间

DataItem

参数名类型描述
TimestampString指标聚合时间,即指标值对应时间段的开始时刻(每 30s 一聚合)。格式为 RFC3339 规范。
Valuefloat指标数值,浮点数,保留两位小数。
正常返回示例
{
    "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               
                    }
                ]
            }
        ]
    }
}
json