查询集群监控元数据

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

1. 接口描述

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

集群服务，集群组件的角色管理页面，获取集群监控元数据信息

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

接口更新时间：2024-11-01 12:30:40。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeMetricMeta
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	集群实例ID 示例值： tbds-1vzudj86
Services	否	否	Array of String	集群服务列表示例值： 1

3. 输出参数

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

4. 错误码

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

错误码	描述
InternalError	内部错误。
ResourceNotFound.MetricsMetaNotFound	无法找到监控元数据。
ResourceNotFound.ClusterNotFound	无法找到该实例。

5. 示例

示例1 查询集群监控元数据

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeMetricMeta
<公共请求参数>

{
  "InstanceId": "tbds-1vzudj86",
  "ServiceName": "HDFS",
  "NamespaceName": "NameNode"
}

输出示例

{
  "Response": {
    "MetaList": [
      {
        "ServiceName": "HDFS",
        "Namespace": [
          {
            "Name": "NameNode",
            "Groups": [
              {
                "Title": "4007端口",
                "MetricMetas": [
                  {
                    "Name": "HDFS.NN.PORT4007.AUTH",
                    "Unit": "次",
                    "Desc": "验证和授权",
                    "Tags": [
                      {
                        "TagName": "RpcAuthenticationFailures",
                        "TagInfo": "RPC 验证失败次数",
                        "StatisticalMethod": "数据来源 JMX RpcActivityForPort4007:RpcAuthenticationFailures 变化量，表示采样间隔内sasl请求认证失败次数"
                      },
                      {
                        "TagName": "RpcAuthenticationSuccesses",
                        "TagInfo": "RPC 验证成功次数",
                        "StatisticalMethod": "数据来源 JMX RpcActivityForPort4007:RpcAuthenticationSuccesses 变化量，表示采样间隔内sasl请求认证成功次数"
                      },
                      {
                        "TagName": "RpcAuthorizationFailures",
                        "TagInfo": "RPC 授权失败次数",
                        "StatisticalMethod": "数据来源 JMX RpcActivityForPort4007:RpcAuthorizationFailures 变化量，表示采样间隔内请求授权失败次数"
                      },
                      {
                        "TagName": "RpcAuthorizationSuccesses",
                        "TagInfo": "RPC 授权成功次数",
                        "StatisticalMethod": "数据来源 JMX RpcActivityForPort4007:RpcAuthorizationSuccesses 变化量，表示采样间隔内请求授权成功次数"
                      }
                    ],
                    "Selected": false
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "RequestId": "803d8c6b-f266-46ba-a4e4-5106a5e97485"
  }
}