腾讯云可观测平台获取TopN监控数据

1. 接口描述

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

支持TopN查询，对于给定的监控指标和时间区间，按照指标大小按序返回不同维度组合及数据。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetTopNMonitorData。
Version	是	String	公共参数，本接口取值：2018-07-24。
Region	是	String	公共参数，详见产品支持的地域列表。
N	是	Integer	topN 示例值：20
StartTime	是	Timestamp ISO8601	起始时间示例值：2020-05-11T14:52:44+08:00
EndTime	是	Timestamp ISO8601	截止时间示例值：2020-05-11T14:52:44+08:00
Instances.N	是	Array of Instance	实例对象的维度组合，格式为key-value键值对形式的集合。不同类型的实例字段完全不同，如CVM为[{"Name":"InstanceId","Value":"ins-j0hk02zo"}]，Ckafka为[{"Name":"instanceId","Value":"ckafka-l49k54dd"}]，COS为[{"Name":"appid","Value":"1258344699"},{"Name":"bucket","Value":"rig-1258344699"}]。各个云产品的维度请参阅各个产品监控指标文档，对应的维度列即为维度组合的key，value为key对应的值。单请求最多支持批量拉取50个实例的监控数据。示例值：[{"Dimensions":[{"Name":"netgroup","Value":"-1"}]}]
MetricName	是	String	指标名称，如Bwpresourcebandwidthin，仅支持单指标拉取。各个云产品的详细指标说明请参阅各个产品监控指标文档，对应的指标英文名即为MetricName 示例值：Bwpresourcebandwidthin
Namespace	是	String	命名空间，如QCE/CVM。各个云产品的详细命名空间说明请参阅各个产品监控指标文档示例值：QCE/BWP
Period	否	Integer	监控统计周期，如60。默认为取值为60，单位为s。每个指标支持的统计周期不一定相同，各个云产品支持的统计周期请参阅各个产品监控指标文档，对应的统计周期列即为支持的统计周期。示例值：60

3. 输出参数

参数名称	类型	描述
MetricName	String	指标名示例值：Bwpresourcebandwidthin
Period	Integer	统计周期示例值：60
N	Integer	topN
OrderedDataPoints	Array of SingleOrderedDataPoint	排序的监控数据
Msg	String	返回信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取BWP带宽Top5的监控数据

根据某个netgroup实例，查看一段时间范围内带宽Top5的u_id数据。

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTopNMonitorData
<公共请求参数>

{
    "Namespace": "QCE/BWP",
    "MetricName": "Bwpresourcebandwidthin",
    "Period": 60,
    "StartTime": "2024-09-05T00:27:00+08:00",
    "EndTime": "2024-09-05T23:27:00+08:00",
    "N": 5,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "netgroup",
                    "Value": "-1"
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "MetricName": "Bwpresourcebandwidthin",
        "Period": 60,
        "N": 5,
        "OrderedDataPoints": [
            {
                "Dimensions": [
                    {
                        "Name": "appid",
                        "Value": "251236571"
                    },
                    {
                        "Name": "netgroup",
                        "Value": "-1"
                    },
                    {
                        "Name": "u_id",
                        "Value": "eip-3xq5lcpb"
                    }
                ],
                "Timestamp": 1725496200,
                "Value": 19411.2,
                "Order": 1
            },
            {
                "Dimensions": [
                    {
                        "Name": "u_id",
                        "Value": "eip-bhhl5d0l"
                    },
                    {
                        "Name": "appid",
                        "Value": "251236571"
                    },
                    {
                        "Name": "netgroup",
                        "Value": "-1"
                    }
                ],
                "Timestamp": 1725495840,
                "Value": 2224,
                "Order": 2
            },
            {
                "Dimensions": [
                    {
                        "Name": "appid",
                        "Value": "251236571"
                    },
                    {
                        "Name": "netgroup",
                        "Value": "-1"
                    },
                    {
                        "Name": "u_id",
                        "Value": "eip-7mg0n41b"
                    }
                ],
                "Timestamp": 1725496200,
                "Value": 2088,
                "Order": 3
            },
            {
                "Dimensions": [
                    {
                        "Name": "netgroup",
                        "Value": "-1"
                    },
                    {
                        "Name": "u_id",
                        "Value": "eip-r2n5fxfr"
                    },
                    {
                        "Name": "appid",
                        "Value": "251195348"
                    }
                ],
                "Timestamp": 1725495840,
                "Value": 1759.2,
                "Order": 4
            },
            {
                "Dimensions": [
                    {
                        "Name": "netgroup",
                        "Value": "-1"
                    },
                    {
                        "Name": "u_id",
                        "Value": "eip-bl7z49yd"
                    },
                    {
                        "Name": "appid",
                        "Value": "251236571"
                    }
                ],
                "Timestamp": 1725496140,
                "Value": 1568,
                "Order": 5
            }
        ],
        "RequestId": "yql-qqqqqqqqq",
        "Msg": "Success"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.ErrNotOpen	未开通。
FailedOperation.ErrOwed	欠费。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
UnsupportedOperation	操作不支持。

获取TopN监控数据

本页目录：