Skip to content

重启

1. 接口定位

  • 接口名称: 重启
  • 所属域: admin/system
  • 业务目标: 通过写入 ETCD 重启标记触发系统重启流程

2. 请求定义

  • Method: POST
  • Path: /restart
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等;每次调用都会写入新的时间戳

3. 请求参数

Header 参数

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

Body 参数

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

4. 响应结构

通用响应包裹

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

data 字段

  • 本接口会立即返回 null,实际 ETCD 写入在后台异步执行。

5. 业务规则

  • 仅管理员可以调用。
  • 当前实现依赖 ETCD 客户端。
  • 接口收到请求后会立即返回成功,同时后台等待约 200ms,随后向 etcd.BuildKey(etcd.RestartKey) 写入当前 Unix 秒级时间戳字符串。
  • 后台写入失败只记录日志,不会再通过 HTTP 回传。

6. 错误码与失败场景

错误码场景典型报错
-token 无效或非管理员由鉴权中间件返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/restart", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440807",
    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. 时序流程

  1. 中间件校验管理员 token。
  2. 启动后台重启任务并立即返回成功响应。
  3. 后台等待约 200ms
  4. 向 ETCD 的重启标记键写入当前时间戳。

9. 变更记录

  • 2026-03-31: 首版发布,基于系统重启接口的异步 ETCD 写入逻辑补全文档。