查询配置组

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

1. 接口描述

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

查询配置组信息

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

接口更新时间:2025-07-17 02:24:32。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeConfigGroup
Version String 公共参数,本接口取值:2019-01-03
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId String 集群实例ID
示例值: tbds-664nmwbe
ServiceName String 服务名称
示例值: HDFS
DisplayStrategy String 默认空,容器版传"native"
示例值: 1

3. 输出参数

参数名称 类型 描述
TotalCnt Int64 配置组总数
示例值: 1
ConfGroupsInfo Array of ConfGroupInfo 配置组信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:查看
AliasInfo String 节点的别名
示例值: 1
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError 内部错误。
FailedOperation 操作失败。
InternalError.CamCgwError 内部服务调用异常。
ResourceNotFound.ServiceGroupNotFound 无法找到该服务组件。
ResourceNotFound.InstanceNotFound 无法找到该实例。
UnsupportedOperation.ServiceNotSupport 该服务不支持此操作。
InternalError.WoodServerError 内部服务调用异常。
UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。
ResourceNotFound.ClusterNotFound 无法找到该实例。
ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。

5. 示例

示例1 查询配置组

输入示例

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

{
  "InstanceId": "tbds-664nmwbe",
  "ServiceName": "HDFS"
}

输出示例

{
  "Response": {
    "AliasInfo": "eyJjb3JlIjoiY29yZSIsIm1hc3RlciI6Im1hc3RlciIsInRhc2siOiJ0YXNrIn0=",
    "ConfGroupsInfo": [
      {
        "ClusterId": "tbds-664nmwbe",
        "ConfGroupDesc": "Default configuration group for hdfs master,core nodes",
        "ConfGroupId": 27029,
        "ConfGroupName": "hdfs-master,core-defaultGroup",
        "ConfGroupType": 0,
        "NodeType": "master,core",
        "NodesInfo": [
          {
            "Arch": "aarch64",
            "ChargType": 0,
            "CpuNum": 32,
            "HostId": 9,
            "Hostname": "tbds-10-4-2-120",
            "HwDiskSize": 536870912000,
            "HwDiskSizeDesc": "500.00 GB",
            "HwMemSize": 67186589696,
            "HwMemSizeDesc": "62.57 GB",
            "Ip": "10.4.2.120",
            "MCMultiDisk": [
              {
                "Count": 1,
                "Path": "/",
                "Type": 16,
                "Volume": 214747299328,
                "storageId": ""
              },
              {
                "Count": 1,
                "Path": "/data",
                "Type": 16,
                "Volume": 536870912000,
                "storageId": ""
              }
            ],
            "MachineType": "s29",
            "NameTag": "master.1,core.1",
            "Rack": "/rack1",
            "ResourceId": "tbds-qqknraokef",
            "SerialNo": "d67de2ed-2f22-407f-87cf-75d76e2d3039",
            "Spec": "",
            "StorageType": 0,
            "Tags": null
          },
          {
            "Arch": "aarch64",
            "ChargType": 0,
            "CpuNum": 32,
            "HostId": 10,
            "Hostname": "tbds-10-4-2-13",
            "HwDiskSize": 536870912000,
            "HwDiskSizeDesc": "500.00 GB",
            "HwMemSize": 67186589696,
            "HwMemSizeDesc": "62.57 GB",
            "Ip": "10.4.2.13",
            "MCMultiDisk": [
              {
                "Count": 1,
                "Path": "/",
                "Type": 16,
                "Volume": 214747299328,
                "storageId": ""
              },
              {
                "Count": 1,
                "Path": "/data",
                "Type": 16,
                "Volume": 536870912000,
                "storageId": ""
              }
            ],
            "MachineType": "v23",
            "NameTag": "master.2,core.2",
            "Rack": "/rack1",
            "ResourceId": "tbds-lauqr9hvnz",
            "SerialNo": "d6ce9922-8724-4509-9eba-cad8e3fe7a4a",
            "Spec": "",
            "StorageType": 0,
            "Tags": [
              {
                "TagKey": "auto_custom_tag_2755885376",
                "TagValue": "auto_custom_tag_v_441958118"
              }
            ]
          },
          {
            "Arch": "aarch64",
            "ChargType": 0,
            "CpuNum": 32,
            "HostId": 11,
            "Hostname": "tbds-10-4-2-93",
            "HwDiskSize": 10485760000,
            "HwDiskSizeDesc": "9.77 GB",
            "HwMemSize": 67186589696,
            "HwMemSizeDesc": "62.57 GB",
            "Ip": "10.4.2.93",
            "MCMultiDisk": [
              {
                "Count": 1,
                "Path": "/data",
                "Type": 16,
                "Volume": 536870912000,
                "storageId": ""
              },
              {
                "Count": 1,
                "Path": "",
                "Type": 16,
                "Volume": 536870912000,
                "storageId": ""
              },
              {
                "Count": 1,
                "Path": "/",
                "Type": 16,
                "Volume": 214747299328,
                "storageId": ""
              }
            ],
            "MachineType": "cvm",
            "NameTag": "master.3,core.3",
            "Rack": "/rack1",
            "ResourceId": "tbds-ohizdx8t80",
            "SerialNo": "d4c02725-25cb-4801-87a6-3d9578bb671c",
            "Spec": "",
            "StorageType": 0,
            "Tags": [
              {
                "TagKey": "auto_custom_tag_1072173869",
                "TagValue": "auto_custom_tag_v_1497103071"
              }
            ]
          }
        ],
        "ServiceType": 1
      },
      {
        "ClusterId": "tbds-664nmwbe",
        "ConfGroupDesc": "default configuration group for hdfs core nodes",
        "ConfGroupId": 27032,
        "ConfGroupName": "hdfs-core-defaultGroup",
        "ConfGroupType": 0,
        "NodeType": "core",
        "NodesInfo": [],
        "ServiceType": 1
      },
      {
        "ClusterId": "tbds-664nmwbe",
        "ConfGroupDesc": "default configuration group for hdfs master nodes",
        "ConfGroupId": 27074,
        "ConfGroupName": "hdfs-master-defaultGroup",
        "ConfGroupType": 0,
        "NodeType": "master",
        "NodesInfo": [],
        "ServiceType": 1
      }
    ],
    "RequestId": "1bf463ec-dd98-4db9-93b1-66f64ffa2c97",
    "TotalCnt": 3
  }
}