获取集群配置文件

最近更新时间:2026-04-16 01:14:43

我的收藏

1. 接口描述

接口请求域名: cdwdoris.tencentcloudapi.com 。

获取集群的最新的几个配置文件(config.xml、metrika.xml、user.xml)的内容,显示给用户

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterConfigs。
Version String 公共参数,本接口取值:2021-12-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群实例ID
示例值:cdwch-f625kxu6
ConfigType Integer 0 公有云查询;1青鹅查询,青鹅查询显示所有需要展示的
示例值:1
FileName String 模糊搜索关键字文件
示例值:Keytab
ClusterConfigType Integer 0集群维度 1节点维度 2启动脚本 3计算组维度
示例值:0
IPAddress String eth0的ip地址
示例值:127.0.0.1
ComputeGroupId String 计算组id
示例值:tchd-f625kxu6-123ac

3. 输出参数

参数名称 类型 描述
ClusterConfList Array of ClusterConfigsInfoFromEMR 返回实例的配置文件相关的信息
BuildVersion String 返回当前内核版本 如果不存在则返回空字符串
示例值:version
ErrorMsg String 错误信息
示例值:error
HasCN Boolean 是否包含CN节点
示例值:true
ExistingJarConfList Array of ClusterConfigsInfoFromEMR 实例已经存在的jar包列表
IPDBFileSizeLimit String ipdb的文件大小 byte
示例值:31311
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取配置

输入示例

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterConfigs
<公共请求参数>

{

  "InstanceId": "cdwdoris-xxxxxxxx",
  "ConfigType": 0,
  "ClusterConfigType": 0,
  "IPAddress": ""
}

输出示例

{
    "Response": {
        "ClusterConfList": [
            {
                "ComputeGroupId": "",
                "FileName": "fe.conf",
                "FileConf": "priority_networks = 10.0.0.0/24\n...",
                "FilePath": "/usr/local/service/doris/conf",
                "KeyConf": "",
                "OriParam": "base64编码后的原始配置内容",
                "NeedRestart": 0,
                "FileKeyValuesNew": [
                    {
                        "KeyName": "priority_networks",
                        "Value": "10.0.0.0/24",
                        "Message": "配置说明",
                        "Display": 1,
                        "SupportHotUpdate": 0
                    }
                ]
            },
            {
                "ComputeGroupId": "",
                "FileName": "be.conf",
                "FileConf": "...",
                "FilePath": "/usr/local/service/doris/conf",
                "KeyConf": "",
                "OriParam": "base64编码后的原始配置内容",
                "NeedRestart": 0,
                "FileKeyValuesNew": [
                    {
                        "KeyName": "be_port",
                        "Value": "9060",
                        "Message": "",
                        "Display": 1,
                        "SupportHotUpdate": 0
                    }
                ]
            }
        ],
        "ExistingJarConfList": [
            {
                "ComputeGroupId": "",
                "FileName": "mysql-connector-java-8.0.28.jar",
                "FileConf": "",
                "FilePath": "/path/to/jar",
                "KeyConf": "",
                "OriParam": "jdbc:mysql://host:port/db",
                "NeedRestart": 0,
                "FileKeyValuesNew": []
            }
        ],
        "HasCN": false,
        "RequestId": "bb1a7d1f-d2b0-4470-984d-c2d0f8963071",
        "ErrorMsg": "",
        "BuildVersion": "doris-2.0.3-rc06"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码