Skip to content

设置建群模式

1. 接口定位

  • 接口名称: 设置建群模式
  • 所属域: admin/group
  • 业务目标: 修改全局建群权限模式

2. 请求定义

  • Method: POST
  • Path: /adminx/group/create_mode/set
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 幂等(相同 mode 可重复提交)

3. 请求参数

Header 参数

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

Body 参数

字段必填类型说明
modestring建群模式:all / disabled / whitelist

4. 响应结构

通用响应包裹

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

data 字段

  • 成功时返回空对象。

5. 业务规则

  • 服务端会对 modetrim + lower 归一化。
  • 空字符串最终会被归一化为 all
  • 当前实现不会显式枚举校验非法模式值,若后续读取时发现未知值,检查接口会返回 group create mode invalid

6. 错误码与失败场景

错误码场景典型报错
1001Header 缺少 operationIDheader must have operationID
-缺少管理员 token由管理员鉴权链路返回
-配置写入失败由配置存储链路返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10011/adminx/group/create_mode/set", {
  method: "POST",
  headers: {
    operationID: "group-create-mode-set-001",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    mode: "whitelist",
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "mode": "whitelist"
}

成功响应示例

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

8. 时序流程

  1. 中间件校验管理员 token。
  2. RPC 层对 mode 执行 trim + lower 归一化。
  3. 将归一化后的模式写入配置项 groupCreateMode
  4. 返回空对象表示设置完成。

9. 变更记录

  • 2026-04-06: 补全文档结构,修正真实服务前缀为 /adminx