文档中心
星图
服务端 API
实时监控
查询实时规模

查询实时规模

更新时间：2025-02-08 10:08

描述

获取最近 2 小时的实时推拉流并发数、房间并发数、在线用户数、最大房间用户数以及混流并发数。返回数据粒度为秒。

接口原型

请求方法：GET
请求地址：https://analytics-api.zego.im/?Action=GetRealtimeUsage
传输协议：HTTPS
调用频率限制（同一 AppID）：3 次/分，480 次/天
数据延迟：3分钟

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
Metrics[]	Array of String	是	需要查询的指标，支持以下字符串： publish_concurrent：推流并发。 play_concurrent: 拉流并发。 room_concurrent: 房间并发。 online_user: 在线用户数。 max_room_user：最大房间用户数 mix_concurrent: 混流并发。
StartTs	Number	是	开始时间，UTC 时间戳，单位为毫秒。
EndTs	Number	是	结束时间，UTC 时间戳，单位为毫秒。如果推流未结束，则可以用 0 或者当前时间戳表示进行中。

请求示例

https://analytics-api.zego.im/?Action=GetRealtimeUsage
&Metrics[]=publish_concurrent
&Metrics[]=online_user
&StartTs=1672565276000
&EndTs=1672565456000
&<公共请求参数>

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Array	响应数据。
Metrics	Array of Object	指标列表。
Metric	String	指标名称。
Values	Array of Object	指标值列表。
Timestamp	Number	UTC 时间戳，单位为毫秒。
Value	Number	指标值。

响应示例

{
    "Code": 0,
    "Message": "success",
    "Data": {
        "Metrics": [
            {
                "Metric": "publish_concurrent",
                "Values": [
                    {
                        "Timestamp": 1660634097767,
                        "Value": 1000
                    }
                ]
            },
            {
                "Metric": "online_user",
                "Values": [
                    {
                        "Timestamp": 1660634097767,
                        "Value": 99999
                    }
                ]
            }
        ]
    },
    "RequestId": 1660645050860325000
}

返回码

返回码	说明	处理意见
0	成功。	-
500	接口错误。	请联系 ZEGO 技术支持。
10001	参数格式错误。	请检查参数。
10002	参数错误或参数无效。	请检查参数。
30002	接口请求频率超过上限。	请确认对应接口的 QPS 限制，降低请求频率。