1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标)
joinSuccessRate:加入频道成功率。
joinSuccessIn5sRate:5s内加入频道成功率。
audioFreezeRate:音频卡顿率。
videoFreezeRate:视频卡顿率。
networkDelay :网络延迟率。
注意:
1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。
2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTRTCMarketQualityMetricData。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | String | 用户SdkAppId(如:1400xxxxxx) 示例值:"1400188366" |
StartTime | 是 | Date | 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) 示例值:2022-10-20 |
EndTime | 是 | Date | 查询结束时间,格式为YYYY-MM-DD。 示例值:2022-10-21 |
Period | 是 | String | 返回数据的粒度,支持设为以下值: d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 示例值:"d" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | TRTCDataResp | TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTRTCMarketQualityMetricData
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTRTCMarketQualityMetricData
<公共请求参数>
{
"StartTime": "2022-10-01",
"EndTime": "2022-10-13",
"Period": "d",
"SdkAppId": "1400188366"
}
输出示例
{
"Response": {
"Data": {
"StatementID": 0,
"Series": [
{
"Columns": [
"time",
"videoFreezeRate",
"audioFreezeRate",
"networkDelay",
"joinSuccessRate",
"joinSuccessRate"
],
"Values": [
[
1664553600,
2.217581018881752,
0.5328453940234894,
0.3013997510316756,
97.95918367346938,
97.95918367346938
],
[
1664640000,
3.392116310528898,
0.17430339496653524,
0.08710108562352477,
98.18181818181819,
98.18181818181819
],
[
1664726400,
2.242237027877107,
0.6513981832034338,
0.1171609034713461,
98.21428571428571,
96.42857142857143
],
[
1664812800,
1.2540262484656994,
0.10000228613558222,
0.026161712971789295,
95.65217391304348,
95.65217391304348
],
[
1664899200,
2.0387375523733438,
0.3573173953636354,
0.20206969697319535,
98.11320754716981,
98.11320754716981
],
[
1664985600,
4.237787988109656,
0.7134409188069496,
0.14704888397100485,
98.33333333333333,
98.33333333333333
],
[
1665072000,
1.2503420076985923,
0.5437361749192481,
0.01987029513935762,
97.10144927536231,
97.10144927536231
],
[
1665158400,
2.827661481850274,
0.27880314391303734,
0.25404666952118315,
96.58316291751873,
95.31672996396922
],
[
1665244800,
2.3367388331307213,
0.47179729012411875,
0.756283289682675,
96.85185185185186,
96.00312757201647
],
[
1665331200,
2.025790869145893,
0.3661555356751269,
1.2037946900891334,
95.83333333333333,
94.56798245614036
],
[
1665417600,
1.7312029049706419,
0.38615952743673804,
0.7458501568405749,
97.89973859914336,
97.33835663895188
],
[
1665504000,
2.383380614959001,
0.6752303123715754,
0.42152506276385404,
98.65139949109415,
97.35368956743002
],
[
1665590400,
2.5176695760288497,
0.5395212846043457,
0.8175603324240602,
97.44958481613286,
96.27817319098459
]
]
}
],
"Total": 1
},
"RequestId": "yjr3nvoptmg1645dhc1cht8bpd6otxda"
}
}
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 | 操作不支持。 |