查询集群日志服务元数据

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

1. 接口描述

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

在集群监控的日志搜索下，在日志源使用日志服务元数据信息，包括了每个服务的不同角色

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

接口更新时间：2024-11-30 02:43:24。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Hosts Array of String 集群ip
注意：此字段可能返回 null，表示取不到有效值。
示例值： 1
ServiceRoles Array of LogServices 服务角色列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
Services Array of String 服务列表
注意：此字段可能返回 null，表示取不到有效值。
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError.EMRCCException EMRCC异常。
ResourceNotFound.MetricsMetaNotFound 无法找到监控元数据。
ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。
ResourceNotFound.ClusterNotFound 无法找到该实例。
InternalError 内部错误。

5. 示例

示例1 查询集群日志服务元数据

输入示例

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

{
  "InstanceId": "tbds-1vzudj86"
}

输出示例

{
  "Response": {
    "Hosts": [
      "172.16.0.89",
      "172.16.0.55",
      "172.16.0.71",
      "172.16.0.117",
      "172.16.0.121",
      "172.16.0.44",
      "172.16.0.109",
      "172.16.0.112"
    ],
    "RequestId": "9c7e3b75-97cd-41fa-9636-343f978e3328",
    "ServiceRoles": [
      {
        "ServiceName": "HBASE",
        "Roles": [
          "HbaseThrift",
          "RegionServer",
          "HMaster"
        ]
      },
      {
        "ServiceName": "HDFS",
        "Roles": [
          "NameNode",
          "DataNode",
          "JournalNode",
          "ZKFailoverController"
        ]
      },
      {
        "ServiceName": "HIVE",
        "Roles": [
          "HS2Audit",
          "HMSAudit",
          "HiveServer2",
          "HiveWebHcat",
          "HiveMetaStore"
        ]
      },
      {
        "ServiceName": "HUE",
        "Roles": [
          "Hue"
        ]
      },
      {
        "ServiceName": "IMPALA",
        "Roles": [
          "Impala-Daemon",
          "Impala-Catalog",
          "Impala-Statestore"
        ]
      },
      {
        "ServiceName": "KAFKA",
        "Roles": [
          "KafkaManager",
          "Kafka"
        ]
      },
      {
        "ServiceName": "KNOX",
        "Roles": [
          "Gateway"
        ]
      },
      {
        "ServiceName": "KYUUBI",
        "Roles": [
          "KyuubiServer"
        ]
      },
      {
        "ServiceName": "SPARK",
        "Roles": [
          "SparkJobHistoryServer"
        ]
      },
      {
        "ServiceName": "TRINO",
        "Roles": [
          "Trino-Worker",
          "Trino-Coordinator"
        ]
      },
      {
        "ServiceName": "YARN",
        "Roles": [
          "ResourceManager",
          "NodeManager",
          "JobHistoryServer"
        ]
      },
      {
        "ServiceName": "ZOOKEEPER",
        "Roles": [
          "Zookeeper"
        ]
      }
    ],
    "Services": [
      "Zookeeper",
      "Impala",
      "Hue",
      "HDFS",
      "YARN",
      "Trino",
      "Knox",
      "HBase",
      "Spark",
      "Hive",
      "Kafka",
      "Kyuubi"
    ]
  }
}