Skip to content

查询开关

1. 接口定位

  • 接口名称: 查询开关
  • 所属域: admin/config
  • 业务目标: 查询当前 ETCD 配置中心开关是否开启

2. 请求定义

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

3. 请求参数

Header 参数

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

Body 参数

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

4. 响应结构

通用响应包裹

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

data 字段

字段类型说明
enablebool是否启用配置中心

5. 业务规则

  • 仅管理员可以调用。
  • 当前实现直接读取 ETCD 中的 EnableConfigCenterKey
  • 当键存在且值等于 enable 时返回 true,否则返回 false
  • 本接口依赖 ETCD 客户端;当前代码未对非 ETCD 场景做额外保护。

6. 错误码与失败场景

错误码场景典型报错
-ETCD 读取失败getEnableConfigManager failed

7. 示例

fetch 请求示例

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

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "enable": true
  }
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 读取 ETCD 中的配置中心开关键。
  3. 将键值转换为布尔结果。
  4. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于配置中心开关查询逻辑补全文档。