Skip to content

租户 API

多租户管理,适用于团队和企业部署。

版本说明企业版独有。个人版无多租户,租户固定为 default,不存在该接口组。所有路径位于 /api/v1/tenants 前缀(注意并非 /api/tenants)。默认端口 8080。组级要求 RequireAdmin


GET /api/v1/tenants

获取租户列表(分页)。

响应:

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "tnt_default",
        "name": "默认租户",
        "plan": "enterprise",
        "member_count": 25,
        "created_at": "2026-01-01T00:00:00Z"
      }
    ],
    "total": 3,
    "page": 1,
    "page_size": 20
  },
  "message": "ok",
  "request_id": "req_abc123"
}

POST /api/v1/tenants

创建租户。

字段类型必填说明
namestring租户名称,2–64 字符
planstring套餐:free / pro / enterprise

GET /api/v1/tenants/:id

获取租户详情。


DELETE /api/v1/tenants/:id

删除租户。


租户配置

方法路径说明
GET/api/v1/tenants/:id/config读取租户配置(配额、开关等)
PUT/api/v1/tenants/:id/config更新租户配置

部门与成员

企业版以「部门(department)→ 成员(member)」组织租户人员:

方法路径说明
GET/api/v1/tenants/:id/departments部门列表
POST/api/v1/tenants/:id/departments新建部门
GET/api/v1/tenants/:id/departments/:deptId/members某部门成员列表

旧文档中的 POST /api/v1/tenants/:id/members(直接向租户添加成员)在代码中无对应路由;成员管理经由部门结构进行。


配额

全局配额见企业版管理接口 GET /api/v1/admin/quotasPUT /api/v1/admin/quotas/:tenantID(含部门级配额)。


错误码

场景codemessage
租户不存在40400租户不存在
名称重复40900租户名称已存在