获取配置

1. 接口定位

• 接口名称: 获取配置
• 所属域: admin/config
• 业务目标: 按配置文件名读取当前进程内对应配置，并以 JSON 字符串返回

2. 请求定义

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

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
configName	是	string	配置文件名

支持的 configName

• 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

4. 响应结构

通用响应包裹

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

data 字段

• 成功时 data 是配置对象序列化后的 JSON 字符串，而不是 JSON 对象。

5. 业务规则

• 仅管理员可以调用。
• 服务端从当前进程内配置对象里按名称查找配置，不走 ETCD 读取。
• 如果 configName 未找到，会返回参数错误。

6. 错误码与失败场景

错误码	场景	典型报错
1001	JSON 解析失败	由 BindJSON 详细错误组成
1001	configName 无对应配置	config name not found
-	配置序列化失败	由 JSON Marshal 返回错误

7. 示例

fetch 请求示例

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

请求示例（JSON）

{
  "configName": "redis.yml"
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": "{\"address\":[\"127.0.0.1:6379\"],\"db\":0}"
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "config name not found"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 解析 configName。
3. 从当前配置对象中查找对应配置。
4. 将配置对象序列化为 JSON 字符串并返回。

9. 变更记录

• 2026-03-31: 首版发布，基于配置读取接口的字符串化返回行为补全文档。