查询TRTC实时监控规模数据

最近更新时间:2024-03-12 10:45:11

我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标)
-userCount(在线用户数)
-roomCount(在线房间数)
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
3.除此之外您也可以通过订阅TRTC包月套餐尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTRTCRealTimeScaleData。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,此参数为可选参数。
SdkAppId String 用户SdkAppId(如:1400xxxxxx)
示例值:1400000000
StartTime Integer 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时)
示例值:1665747036
EndTime Integer 结束时间,unix时间戳,单位:秒
示例值:1665747284
RoomId String 房间ID
示例值:23390

3. 输出参数

参数名称 类型 描述
Data TRTCDataResult TRTC监控数据出参
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeTRTCRealTimeScaleData

查询在线TRTC房间和用户

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCRealTimeScaleData
<公共请求参数>

{
    "StartTime": 1695711343,
    "EndTime": 1695711643,
    "SdkAppId": "1400xxxxxx"
}

输出示例

{
    "Response": {
        "Data": {
            "StatementID": 0,
            "Series": [
                {
                    "Columns": [
                        "time",
                        "userCount",
                        "roomCount"
                    ],
                    "Values": [
                        {
                            "RowValue": [
                                1695711350,
                                22,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711360,
                                22,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711370,
                                22,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711380,
                                22,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711390,
                                23,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711400,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711410,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711420,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711430,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711440,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711450,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711460,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711470,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711480,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711490,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711500,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711510,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711520,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711530,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711540,
                                21,
                                18
                            ]
                        },
                        {
                            "RowValue": [
                                1695711550,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711560,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711570,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711580,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711590,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711600,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711610,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711620,
                                22,
                                19
                            ]
                        },
                        {
                            "RowValue": [
                                1695711630,
                                24,
                                20
                            ]
                        },
                        {
                            "RowValue": [
                                1695711640,
                                22,
                                19
                            ]
                        }
                    ]
                }
            ],
            "Total": 1
        },
        "RequestId": "7gb56tcisiuy9el619p3jjkccop9qpv8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
UnsupportedOperation 操作不支持。