获取topn元数据信息

最近更新时间: 2026-09-17 00:05:47

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

集群概览中节点状态TOP10，获取topn元数据信息

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

接口更新时间：2025-07-17 02:08:05。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeTopNMeta
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 集群字符串id
示例值： tbds-1vzudj86
Type 是 否 String topn类型：host-主机维度，process-进程维度
示例值： host
Host 否 否 String 选填，Type为process，进程位于的主机ip
示例值： None

3. 输出参数

参数名称 类型 描述
Meta Array of TopNMeta 元数据信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
TotalCnt Int64 元数据条数
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
ResourceNotFound.ClusterNotFound 无法找到该实例。

5. 示例

示例1 查询主机监控页进程维度topn元数据

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeTopNMeta
&InstanceId=emr-4782e204
&Type=process
&Host=10.0.0.116
&<公共请求参数>

输出示例

{
    "Response": {
        "Meta": [
            {
                "MetricsName": "Top CPU Processes",
                "MetricsId": 1,
                "Desc": "Top CPU Processes"
            },
            {
                "MetricsName": "Top Memory Processes",
                "MetricsId": 2,
                "Desc": "Top Memory Processes"
            },
            {
                "MetricsName": "Top IO Processes",
                "MetricsId": 3,
                "Desc": "Top IO Processes"
            },
            {
                "MetricsName": "Top Network Processes",
                "MetricsId": 4,
                "Desc": "Top Network Processes"
            },
            {
                "MetricsName": "Process List",
                "MetricsId": 5,
                "Desc": "Process List"
            }
        ],
        "RequestId": "4ffe30d3-f3e8-499a-a659-08f0f27cec5a",
        "TotalCnt": 5
    }
}

示例2 查询概览页主机维度topn元数据

输入示例

https://emr.api3.{{conf.domain_main}}/?Action=DescribeTopNMeta
&InstanceId=emr-4782e204
&Type=host
&Host=
&<公共请求参数>

输出示例

{
    "Response": {
        "Meta": [
            {
                "MetricsName": "NODE.CPU",
                "MetricsId": 1,
                "Desc": "CPU使用率"
            },
            {
                "MetricsName": "NODE.CPU.LOAD",
                "MetricsId": 2,
                "Desc": "机器负载"
            },
            {
                "MetricsName": "NODE.MEM_PERCENT",
                "MetricsId": 3,
                "Desc": "内存使用率"
            },
            {
                "MetricsName": "NODE.DISK.SPACE_USED_PERCENT",
                "MetricsId": 4,
                "Desc": "磁盘空间使用率"
            },
            {
                "MetricsName": "NODE.DISK.UTIL_PERCENT",
                "MetricsId": 5,
                "Desc": "磁盘IO使用率"
            },
            {
                "MetricsName": "NODE.NETWORK.RW_BYTES-in",
                "MetricsId": 6,
                "Desc": "网卡入流量"
            },
            {
                "MetricsName": "NODE.NETWORK.RW_BYTES-out",
                "MetricsId": 7,
                "Desc": "网卡出流量"
            }
        ],
        "RequestId": "0ccaf14f-f56e-4c38-9ad1-1863423fdb4e",
        "TotalCnt": 7
    }
}