重置配置
1. 接口定位
- 接口名称: 重置配置
- 所属域: admin/config
- 业务目标: 将本地配置文件中的内容重新同步到 ETCD 配置中心
2. 请求定义
- Method:
POST - Path:
/config/reset_config - 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 | any | 业务数据 |
data 字段
- 本接口会立即返回
null,实际重置在后台异步执行。
5. 业务规则
- 仅管理员可以调用。
- 当前实现依赖 ETCD 客户端,把本地配置重新加载后批量写入 ETCD 事务。
- 实际后台逻辑会逐个重载以下配置文件并与当前内存配置比较,只同步发生变化的项:
discovery.ymllog.ymlmongodb.ymlchat-api-admin.ymlchat-api-chat.ymlchat-rpc-admin.ymlchat-rpc-chat.ymlredis.ymlshare.yml
- 接口返回成功只表示后台任务已启动;后台执行失败只写日志,不会再通过 HTTP 回传。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| - | token 无效或非管理员 | 由鉴权中间件返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/config/reset_config", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440804",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
})
.then((res) => res.json())
.then((data) => console.log(data));成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": null
}8. 时序流程
- 中间件校验管理员 token。
- 立即启动后台重置任务并返回成功响应。
- 后台从本地配置文件重新加载各配置对象。
- 对比当前内存配置,筛出有变化的配置。
- 把变更配置通过 ETCD 事务批量写回配置中心。
9. 变更记录
- 2026-03-31: 首版发布,基于配置重置的异步同步逻辑补全文档。