API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心

拉取公网指标监控数据

最近更新时间：2024-03-12 01:53:36

我的收藏

1. 接口描述

接口请求域名： tdmq.tencentcloudapi.com 。

从腾讯云可观测平台拉取公网指标监控数据，目前仅支持客户端到 LB 的入带宽和出宽带指标。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRocketMQPublicAccessMonitorData。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 专享集群ID
示例值：rocketmq-xxx
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，表示取不到有效值。
示例值：[ { "Timestamps": [ 1535079000, 1535079300, 1535079600, 1535079900, 1535080200, 1535080500 ], "Values": [ 2.566, 2.283, 6.316, 2.816, 2.7, 2.35 ] } ]
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": "abc",
    "StartTime": "abc",
    "EndTime": "abc",
    "Period": 0,
    "MetricName": "abc"
}

输出示例

{
    "Response": {
        "MetricName": "abc",
        "Period": 0,
        "StartTime": "abc",
        "EndTime": "abc",
        "DataPoints": [
            {
                "Timestamps": [
                    0
                ],
                "Values": [
                    0
                ]
            }
        ],
        "Msg": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站
http://www.vxiaotou.com