获取建群模式
1. 接口定位
- 接口名称: 获取建群模式
- 所属域: admin/group
- 业务目标: 获取当前系统使用的建群权限模式
2. 请求定义
- Method:
POST - Path:
/adminx/group/create_mode/get - 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 | object | 业务数据 |
data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
| mode | string | 当前建群模式:all / disabled / whitelist |
5. 业务规则
- 当前模式存储在系统配置项
groupCreateMode中。 - 配置值为空时,服务端按
all处理。 - 服务端会先做
trim + lower归一化,再返回最终模式值。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | Header 缺少 operationID | header must have operationID |
| - | 缺少管理员 token | 由管理员鉴权链路返回 |
| - | 配置读取失败 | 由配置存储链路返回 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10011/adminx/group/create_mode/get", {
method: "POST",
headers: {
operationID: "group-create-mode-get-001",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
})
.then((res) => res.json())
.then((data) => console.log(data));成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"mode": "whitelist"
}
}8. 时序流程
- 中间件校验管理员 token。
- RPC 层读取配置项
groupCreateMode。 - 对配置值执行
trim + lower归一化。 - 返回当前生效模式。
9. 变更记录
- 2026-04-06: 补全文档结构,修正真实服务前缀为
/adminx。