鹰眼 API 文档
Open Platform Document Center

外观

租户管理接口文档 ​

本接口用于对系统中的**租户（Tenant）**资源进行全生命周期管理，遵循 RESTful 设计规范，以 HTTP 方法语义化操作，统一使用 JSON 格式进行数据交互。

资源路径：/system/tenant-api
实体类：TenantDTO（增删改查共用）

公共请求头 ​

⚠️ 注意：本接口需携带有效的 access_token 进行身份验证，未授权访问将被拒绝。

Header 参数（http header）

参数名类型必填说明
AuthorizationString是请求令牌，Bearer [access_token]

接口列表 ​

操作方法路径说明
创建租户POST/system/tenant-api新增一个子租户
查询租户GET/system/tenant-api/{id}根据 id 获取租户详情
更新租户PUT/system/tenant-api全量更新租户信息
删除租户DELETE/system/tenant-api/{id}根据 id 删除租户

实体类定义（TenantDTO） ​

所有接口的请求体（Request Body）或返回数据（Response Data）均基于以下结构：

JSON 示例 ​

点击展开 JSON 数据
json
{
  "id": "1950077397280284674",
  "tenantId": "321579",
  "tenantName": "子租户1",
  "tenantParent": "321578",
  "startTime": "2025-07-27",
  "endTime": "2025-08-09",
  "contactUserName": "111",
  "contactPhone": "111",
  "companyName": "子租户1",
  "status": "0",
  "packageBo": {
    "menuIds": "1926896269713604610, 1923275726558703617, 1926898173030039553, 1926898477108690945, 1926898582297640962, 1935655313756598274, 1930175303830601729, 1930540366252867586, 1927260528184262658"
  },
  "quotaBo": {
    "enterpriseQuery": 1,
    "annualReportQuery": 2,
    "chainReport": 3,
    "businessReport": 4,
    "riskReport": 5,
    "merchant": 6
  },
  "ruleBo": {
    "modelZr": null,
    "modelPf": null,
    "modelEd": null,
    "catalogZr": null,
    "catalogPf": null,
    "catalogEd": null,
    "catalogRw": null
  }
}

主体信息 ​

参数名类型说明
idString系统内部唯一 ID（雪花 ID）
tenantIdString租户业务编码（如：321579）
tenantNameString租户名称
tenantParentString父租户编码
startTimeString服务开始日期，格式：YYYY-MM-DD
endTimeString服务结束日期，格式：YYYY-MM-DD
contactUserNameString联系人姓名
contactPhoneString联系电话
companyNameString公司名称
accountCountInteger账号数量限制，-1 表示无限制
packageBoObject套餐信息
quotaBoObject配额信息
ruleBoObject规则配置

⚠️ 注意：

  • 创建（POST）时：不传 id，由服务端生成。
  • 更新（PUT）时：需提供完整 TenantDTO，包含 id。
  • 查询（GET）时：返回完整对象，含系统字段（如 id、配额等扩展信息）。

套餐信息 ​

参数名类型说明
menuIdsString已授权菜单 ID 列表，以英文逗号分隔

示例 menuIds：
"1926896269713604610, 1923275726558703617, ..."

配额信息 ​

参数名类型说明
enterpriseQueryInteger企业查询总配额
annualReportQueryInteger年报查询总配额
chainReportInteger供应链报告总配额
businessReportInteger经营分析总配额
riskReportInteger风险评估表总配额
merchantInteger客商管理额度

注：所有 字段初始值为 0，表示尚未使用。

规则配置 ​

参数名类型说明
modelZrString准入模型配置
modelPfString评分模型配置
modelEdString授信模型配置
catalogZrString准入目录规则
catalogPfString评分目录规则
catalogEdString授信目录规则
catalogRwString预警目录规则

当前该对象所有字段均为 null，表示未配置规则。

接口详情 ​

创建租户（POST） ​

请求

http
POST /system/tenant-api
Content-Type: application/json
Authorization: Bearer <token>
点击展开 JSON 数据
json
{
  "tenantParent": "父租户id",
  "tenantName": "子租户1",
  "startTime": "2025-07-27",
  "endTime": "2025-08-09",
  "contactUserName": "111",
  "contactPhone": "111",
  "companyName": "子租户1",
  "status": "0",
  "packageBo": {
    "menuIds": "1926896269713604610, 1923275726558703617, 1926898173030039553, 1926898477108690945, 1926898582297640962, 1935655313756598274, 1930175303830601729, 1930540366252867586, 1927260528184262658"
  },
  "quotaBo": {
    "enterpriseQuery": 1,
    "annualReportQuery": 2,
    "chainReport": 3,
    "businessReport": 4,
    "riskReport": 5,
    "riskReportUsed": 0,
    "zr": 0,
    "credit": 7,
    "pf": 8,
    "merchant": 6
  },
  "ruleBo": {
    "modelZr": null,
    "modelPf": null,
    "modelEd": null,
    "catalogZr": null,
    "catalogPf": null,
    "catalogEd": null,
    "catalogRw": null
  }
}

响应

点击展开 JSON 数据
json
{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

查询租户（GET） ​

请求

http
GET /system/tenant-api/1950077397280284674
Authorization: Bearer <token>

路径参数

参数位置必填说明
idpath是租户的系统内部 ID（非 tenantId）

响应

点击展开 JSON 数据
json
{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": "1950077397280284674",
    "tenantId": "321579",
    "tenantName": "子租户1",
    "tenantParent": "321578",
    "startTime": "2025-07-27",
    "endTime": "2025-08-09",
    "contactUserName": "111",
    "contactPhone": "111",
    "companyName": "子租户1",
    "status": "0",
    "packageBo": {
      "menuIds": "1926896269713604610, 1923275726558703617, 1926898173030039553, 1926898477108690945, 1926898582297640962, 1935655313756598274, 1930175303830601729, 1930540366252867586, 1927260528184262658"
    },
    "quotaBo": {
      "enterpriseQuery": 1,
      "annualReportQuery": 2,
      "chainReport": 3,
      "businessReport": 4,
      "riskReport": 5,
      "merchant": 6
    },
    "ruleBo": {
      "modelZr": null,
      "modelPf": null,
      "modelEd": null,
      "catalogZr": null,
      "catalogPf": null,
      "catalogEd": null,
      "catalogRw": null
    }
  }
}

更新租户（PUT） ​

请求

http
PUT /system/tenant-api
Content-Type: application/json
Authorization: Bearer <token>
点击展开 JSON 数据
json
{
  "id": "1950077397280284674",
  "tenantName": "子租户1",
  "startTime": "2025-07-27",
  "endTime": "2025-08-09",
  "contactUserName": "111",
  "contactPhone": "111",
  "companyName": "子租户1",
  "status": "0",
  "packageBo": {
    "menuIds": "1926896269713604610, 1923275726558703617, 1926898173030039553, 1926898477108690945, 1926898582297640962, 1935655313756598274, 1930175303830601729, 1930540366252867586, 1927260528184262658"
  },
  "quotaBo": {
    "enterpriseQuery": 1,
    "annualReportQuery": 2,
    "chainReport": 3,
    "businessReport": 4,
    "riskReport": 5,
    "riskReportUsed": 0,
    "zr": 0,
    "credit": 7,
    "pf": 8,
    "merchant": 6
  },
  "ruleBo": {
    "modelZr": null,
    "modelPf": null,
    "modelEd": null,
    "catalogZr": null,
    "catalogPf": null,
    "catalogEd": null,
    "catalogRw": null
  }
}

🔁 注意：此为全量更新，未传字段将被置空或重置，id必传。

响应

点击展开 JSON 数据
json
{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

删除租户（DELETE） ​

请求

http
DELETE /system/tenant-api/1950077397280284674
Authorization: Bearer <token>

路径参数

参数位置必填说明
idpath是租户的系统内部 ID

响应

点击展开 JSON 数据
json
{
  "code": 200,
  "msg": "操作成功",
  "data": null
}

安全说明 ​

  • 所有请求必须携带有效的 access_token 参数。
  • access_token 应通过登录接口获取，且具有时效性和权限限制。
  • 未授权访问将返回错误码并拒绝请求。