← 返回首页

API模块详情

当前查看模块:system

公共请求头(所有接口适用)

参数名 必填 类型 示例 说明
Authorization string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用,无需传 X-Client。。认证 Token,请在请求头中携带,推荐格式:Bearer {token}
X-Client string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填,用于密钥认证。线上文档: http://localhost:5601/docs
X-Site string <site key> 站点标识(必填)。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code string AUTH_MANAGEMENT 系统编码(必填)。用于指定当前访问的业务系统(例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT)。当系统不支持时将返回“登录用户不支持当前系统,可联系管理员处理”。

系统管理

模块标识: system | 接口数量: 5

POST 业务开通 /system/business/activate

查看详情
业务开通接口
请求参数

请求体

{
  "systemCode": "string|必填,要开通的系统编码",
  "expireDays": "number|可选,业务有效天数"
}

请按照示例结构封装请求体字段,并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "业务开通成功",
    "data": {
      "systemCode": "AUTH",
      "activated": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "业务开通失败",
    "data": null
  }
}
注意事项
  • 需管理员身份调用

POST 用户存储模式切换 /system/storage/switch

查看详情
用户存储模式切换功能
请求参数

请求体

{
  "mode": "string|必填,目标存储模式,可选 'FILE' 或 'CLOUD'"
}

请按照示例结构封装请求体字段,并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "切换存储模式成功",
    "data": {
      "mode": "FILE"
    }
  },
  "failure": {
    "code": "4000",
    "message": "切换存储模式失败",
    "data": null
  }
}
注意事项
  • 切换后会自动重启数据源,请确保备份

POST 客户端用户存储模式切换 /system/storage/client/switch

查看详情
客户端用户存储模式切换功能
请求参数

请求体

{
  "mode": "string|必填,目标存储模式,可选 'FILE' 或 'CLOUD'"
}

请按照示例结构封装请求体字段,并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "切换客户端用户存储模式成功",
    "data": {
      "mode": "FILE"
    }
  },
  "failure": {
    "code": "4000",
    "message": "切换客户端用户存储模式失败",
    "data": null
  }
}

GET 获取存储模式 /system/storage/mode

查看详情
获取当前存储模式
请求参数

暂无请求参数定义

响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "userMode": "FILE",
      "clientUserMode": "FILE"
    }
  }
}

GET 系统信息 /system/info

查看详情
获取系统基本信息
请求参数

暂无请求参数定义

响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "version": "1.0.0",
      "buildTime": "2025-01-01T10:00:00.000Z",
      "storageMode": "FILE"
    }
  }
}