- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 客户端API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 客户端API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale Metrics (the following metrics will be returned) -userCount (Online users) -roomCount (Online rooms) Note: 1. To call the interface, you need to activate the monitoring dashboard Standard Edition and Premium Edition, the monitoring dashboard Free Edition does not support calling. For monitoring dashboard version features and billing overview, please visit: https://trtc.io/document/54481. 2. The query time range depends on the function version of the monitoring dashboard. The premium edition can query the last 1 hours
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeTRTCRealTimeScaleData. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| SdkAppId | Yes | String | User SDKAppId (e.g., 1400xxxxxx) |
| StartTime | Yes | Integer | Start time, unix timestamp, Unit: seconds (Query time range depends on the function version of the monitoring dashboard, premium edition can query up to 1 hours) |
| EndTime | Yes | Integer | End time, unix timestamp, Unit: seconds |
| RoomId | No | String | Room ID |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Data | TRTCDataResult | TRTC Real- Time Monitoring output parameter |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 DescribeTRTCRealTimeScaleData
Query online TRTC rooms and users
Input Example
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCRealTimeScaleData
<Public request parameters>
{
"StartTime": 1695711343,
"EndTime": 1695711643,
"SdkAppId": "1400xxxxxx"
}
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| UnsupportedOperation | Unsupported operation. |
是
否
本页内容是否解决了您的问题？