获取组件配置信息-配置管理页

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

1. 接口描述

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

获取组件配置信息（配置管理页）

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

接口更新时间：2025-07-17 03:32:57。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeServiceConfsNew
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	集群字符串ID 示例值： tbds-nu7ckm3g
ServiceName	是	否	String	组件名示例值： ZOOKEEPER
ConfFileName	否	否	String	配置文件名称，可为空，为空代表获取组件下的全部配置文件示例值： jaas.conf
Ip	否	否	String	节点ip，容器版不传示例值： 1
ConfGroupId	否	否	Int64	配置组id 示例值： 1
SearchItemKey	否	否	String	配置项关键词模糊匹配示例值： ee
SearchConfCategories	否	否	Array of String	配置类别筛选示例值： []
PageNo	是	否	Int64	页码，从1开始示例值： 1
PageSize	是	否	Int64	页大小示例值： 50
ComponentScopeNumbers	否	否	Array of Int64	角色编码，例如0对应的是Zookeeper 示例值： [-99]
DisplayStrategy	否	否	String	默认空，容器版传"native" 示例值： 1

3. 输出参数

参数名称	类型	描述
TotalCnt	Int64	配置项总数示例值： 1
ServiceConfItem	ServiceConfItem	配置项列表注意：此字段可能返回 null，表示取不到有效值。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError.CamCgwError	内部服务调用异常。
ResourceNotFound.InstanceNotFound	无法找到该实例。
InternalError.WoodServerError	内部服务调用异常。
ResourceNotFound.ClusterNotFound	无法找到该实例。

5. 示例

示例1 获取组件配置信息（配置管理页）

输入示例

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

{
  "InstanceId": "tbds-nu7ckm3g",
  "ServiceName": "ZOOKEEPER",
  "ConfFileName": "jaas.conf",
  "SearchItemKey": "ee",
  "SearchConfCategories": [],
  "ComponentScopeNumbers": [
    -99
  ],
  "PageNo": 1,
  "PageSize": 50
}

输出示例

{
  "Response": {
    "RequestId": "cb2963b9-8e47-4085-acff-d100feab12b6",
    "ServiceConfItem": {
      "ConfItemAttribute": "{}",
      "FileProperty": "{}",
      "ItemKVList": []
    },
    "TotalCnt": 0
  }
}