配置列表

1. 接口定位

• 接口名称: 配置列表
• 所属域: admin/config
• 业务目标: 获取当前配置中心可管理的配置文件名列表，以及运行环境和版本信息

2. 请求定义

• Method: POST
• Path: /config/get_config_list
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

• 无业务参数，请传空对象 {}。

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

字段	类型	说明
environment	string	当前运行环境，来自 runtimeenv.RuntimeEnvironment()
version	string	当前服务版本号，来自 version.Version
configNames	array<string>	当前支持管理的配置文件名列表

5. 业务规则

• 仅管理员可以调用。
• 返回值来自当前进程内配置对象，不依赖 ETCD 查询。
• configNames 由服务端配置注册表生成，当前实现包括：
  • share.yml
  • redis.yml
  • discovery.yml
  • mongodb.yml
  • log.yml
  • chat-api-admin.yml
  • chat-api-chat.yml
  • chat-rpc-admin.yml
  • chat-rpc-chat.yml

6. 错误码与失败场景

错误码	场景	典型报错
-	token 无效或非管理员	由鉴权中间件返回

7. 示例

fetch 请求示例

fetch("http://localhost:10009/config/get_config_list", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440801",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "environment": "production",
    "version": "3.8.2",
    "configNames": [
      "share.yml",
      "redis.yml",
      "discovery.yml",
      "mongodb.yml",
      "log.yml",
      "chat-api-admin.yml",
      "chat-api-chat.yml",
      "chat-rpc-admin.yml",
      "chat-rpc-chat.yml"
    ]
  }
}

8. 时序流程

1. 中间件校验管理员 token。
2. 从当前配置对象读取配置名列表。
3. 读取运行环境和版本号。
4. 返回统一成功响应。

9. 变更记录

• 2026-03-31: 首版发布，基于配置名列表接口的真实返回结构补全文档。