获取配置文件列表-配置管理页

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

1. 接口描述

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

获取配置文件列表（配置管理页）

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeConfFileList
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 集群字符串ID
示例值： tbds-nu7ckm3g
ServiceName 是 否 String 组件名
示例值： ZOOKEEPER
DisplayStrategy 否 否 String 容器传“native”
示例值： 1

3. 输出参数

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

4. 错误码

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

错误码 描述
InternalError.CamCgwError 内部服务调用异常。
ResourceNotFound.InstanceNotFound 无法找到该实例。
InternalError.WoodServerError 内部服务调用异常。
UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。

5. 示例

示例1 获取配置文件列表（配置管理页）

输入示例

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

{
  "InstanceId": "tbds-nu7ckm3g",
  "ServiceName": "ZOOKEEPER"
}

输出示例

{
  "Response": {
    "ConfFileList": [
      {
        "FileName": "allMixed",
        "FileProperty": {
          "Display": true,
          "Editable": true,
          "FileOwner": "sys",
          "Type": "Mixed"
        }
      },
      {
        "FileName": "jaas.conf",
        "FileProperty": {
          "Display": true,
          "Editable": false,
          "FileOwner": "sys",
          "Type": "KeyValue"
        }
      },
      {
        "FileName": "java.env",
        "FileProperty": {
          "Display": true,
          "Editable": true,
          "FileOwner": "sys",
          "Type": "KeyValue"
        }
      },
      {
        "FileName": "log4j.properties",
        "FileProperty": {
          "Display": true,
          "Editable": true,
          "FileOwner": "sys",
          "Type": "KeyValue"
        }
      },
      {
        "FileName": "zkEnv.sh",
        "FileProperty": {
          "Display": true,
          "Editable": true,
          "FileOwner": "sys",
          "Type": "KeyValue"
        }
      },
      {
        "FileName": "zoo.cfg",
        "FileProperty": {
          "Display": true,
          "Editable": true,
          "FileOwner": "sys",
          "Type": "KeyValue"
        }
      }
    ],
    "RequestId": "be2a14cd-8963-497a-b07e-1fc127105550"
  }
}