1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
查询公网指标监控数据，目前仅支持客户端到 LB 的入带宽和出宽带指标。
当前 API 适用集群：4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRocketMQPublicAccessMonitorData。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群 ID 示例值：rocketmq-a52qova7x97b |
| MetricName | 是 | String | 指标名称，仅支持单指标拉取。指标枚举如下： - ClientIntraffic：入流量 - ClientOuttraffic：出流量 示例值：ClientOuttraffic |
| StartTime | 否 | String | 起始时间 示例值：2018-09-22T19:51:23+08:00 |
| EndTime | 否 | String | 结束时间，默认为当前时间 示例值：2018-09-22T20:51:23+08:00 |
| Period | 否 | Integer | 监控统计周期，如60。默认为取值为300，单位为s。 示例值：60 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MetricName | String | 指标名 注意：此字段可能返回 null，表示取不到有效值。 示例值：ClientOuttraffic |
| Period | Integer | 监控统计周期，如60。默认为取值为300，单位为s。 注意：此字段可能返回 null，表示取不到有效值。 示例值：60 |
| StartTime | String | 起始时间，如2018-09-22T19:51:23+08:00 注意：此字段可能返回 null，表示取不到有效值。 示例值：2018-09-22T19:51:23+08:00 |
| EndTime | String | 结束时间，如2018-09-22T20:51:23+08:00，默认为当前时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2018-09-22T20:51:23+08:00 |
| DataPoints | Array of RocketMQDataPoint | 数据点数组 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 返回信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：succ |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 正常响应
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQPublicAccessMonitorData
<公共请求参数>
{
"InstanceId": "rocketmq-a52qova7x97b",
"StartTime": "2024-12-04T15:06:49+08:00",
"EndTime": "2024-12-04T16:06:49+08:00",
"Period": 60,
"MetricName": "ClientOuttraffic"
}输出示例
{
"Response": {
"StartTime": "2024-12-04T15:06:00+08:00",
"EndTime": "2024-12-04T16:06:00+08:00",
"Period": 60,
"MetricName": "RocketmqPublicNetworkIntrafficVipRatio",
"DataPoints": [
{
"Timestamps": [
1733295960,
1733296020,
1733296080,
1733296140,
1733296200,
1733296260,
1733296320,
1733296380,
1733296440,
1733296500,
1733296560,
1733296620,
1733296680,
1733296740,
1733296800,
1733296860,
1733296920,
1733296980,
1733297040,
1733297100,
1733297160,
1733297220,
1733297280,
1733297340,
1733297400,
1733297460,
1733297520,
1733297580,
1733297640,
1733297700,
1733297760,
1733297820,
1733297880,
1733297940,
1733298000,
1733298060,
1733298120,
1733298180,
1733298240,
1733298300,
1733298360,
1733298420,
1733298480,
1733298540,
1733298600,
1733298660,
1733298720,
1733298780,
1733298840,
1733298900,
1733298960,
1733299020,
1733299080,
1733299140,
1733299200,
1733299260
],
"Values": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
],
"RequestId": "a6ebee33-5790-435a-a204-dda200d360af",
"Msg": ""
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
