1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标)
-视频卡顿率
-音频卡顿率
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTRTCRealTimeQualityMetricData。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | String | 用户SdkAppId(如:1400xxxxxx) 示例值:"1400188366" |
StartTime | 是 | Integer | 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) 示例值:1665747036 |
EndTime | 是 | Integer | 结束时间,unix时间戳,单位:秒 示例值:1665747284 |
RoomId | 否 | String | 房间ID 示例值:23390 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | TRTCDataResp | TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTRTCRealTimeQualityMetricData
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCRealTimeQualityMetricData
<公共请求参数>
{
"StartTime": 1665747036,
"EndTime": 1665747284,
"SdkAppId": "1400188366"
}
输出示例
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"videoFreezeRate",
"audioFreezeRate"
],
"Values": [
[
1665747040,
0,
0
],
[
1665747050,
0,
0
],
[
1665747060,
0,
0
],
[
1665747070,
0,
0
],
[
1665747080,
0,
0
],
[
1665747090,
0,
0
],
[
1665747100,
0,
0
],
[
1665747110,
0,
0
],
[
1665747120,
0,
0
],
[
1665747130,
0,
0
],
[
1665747140,
0,
0
],
[
1665747150,
0,
0
],
[
1665747160,
0,
0
],
[
1665747170,
0,
0
],
[
1665747180,
0,
0
],
[
1665747190,
0,
0
],
[
1665747200,
0,
0
],
[
1665747210,
0,
0
],
[
1665747220,
0,
0
],
[
1665747230,
0,
0
],
[
1665747240,
0,
0
],
[
1665747250,
0,
0
],
[
1665747260,
0,
0
],
[
1665747270,
0,
0
],
[
1665747280,
0,
0
]
]
}
],
"Total": 1
},
"RequestId": "7n-62qgcuuaupi-2wre2ncswqydl9cae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
UnsupportedOperation | 操作不支持。 |