Skip to content

设置开关

1. 接口定位

  • 接口名称: 设置开关
  • 所属域: admin/config
  • 业务目标: 开启或关闭 ETCD 配置中心开关

2. 请求定义

  • Method: POST
  • Path: /config/set_enable_config_manager
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 对相同目标状态重复设置可视为幂等

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
enablebool目标开关状态

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataany业务数据

data 字段

  • 本接口成功时返回 null

5. 业务规则

  • 仅管理员可以调用。
  • 服务端先读取当前 ETCD 开关键状态。
  • 当当前不是启用状态且请求要启用时:
    • 接口立即返回成功
    • 后台等待约 200ms
    • 调用 resetConfig(false, OpPut(enableKey)),把开关键和所有本地配置一起写入 ETCD
  • 其他情况则直接把开关键写入 ETCD。
  • reset_config 一样,后台异步阶段失败只写日志,不再通过 HTTP 回传。

6. 错误码与失败场景

错误码场景典型报错
1001请求 JSON 解析失败BindJSON 详细错误组成
-ETCD 读取失败getEnableConfigManager failed
-ETCD 写入失败setEnableConfigManager failed

7. 示例

fetch 请求示例

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

请求示例(JSON)

json
{
  "enable": true
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": null
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 读取 ETCD 中当前开关键状态。
  3. 如果是首次开启,则后台异步写入开关键并重置全部配置到 ETCD。
  4. 否则直接更新开关键。
  5. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于配置中心开关设置与首次启用回填配置逻辑补全文档。