租户

统一租户管理。集中管理租户账户控制、配置及初始化访问权限等。

---

全文搜索租户

GET

/api/v1/tenant/search

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

name

类型string

no

类型string

type

类型string

有效值

"PERSONAL""ENTERPRISE""GOVERNMENT""UNKNOWN"

status

类型string

有效值

"DISABLED""CANCELLING""CANCELED""ENABLED"

realNameStatus

类型string

有效值

"NOT_SUBMITTED""AUDITING""AUDITED""FAILED_AUDIT"

locked

类型boolean

createdDate

类型string

格式"date-time"

applyCancelDate

类型string

格式"date-time"

lastLockDate

类型string

格式"date-time"

lockStartDate

类型string

格式"date-time"

lockEndDate

类型string

格式"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

有效值

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

有效值

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/tenant/search

试验场

授权

UserHttpBearer

变量

键

值

id

name

no

type

status

realNameStatus

locked

createdDate

applyCancelDate

lastLockDate

lockStartDate

lockEndDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

查询租户列表

GET

/api/v1/tenant

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id

类型integer

格式"int64"

name

类型string

no

类型string

type

类型string

有效值

"PERSONAL""ENTERPRISE""GOVERNMENT""UNKNOWN"

status

类型string

有效值

"DISABLED""CANCELLING""CANCELED""ENABLED"

realNameStatus

类型string

有效值

"NOT_SUBMITTED""AUDITING""AUDITED""FAILED_AUDIT"

locked

类型boolean

createdDate

类型string

格式"date-time"

applyCancelDate

类型string

格式"date-time"

lastLockDate

类型string

格式"date-time"

lockStartDate

类型string

格式"date-time"

lockEndDate

类型string

格式"date-time"

pageNo

页面数据大小，默认为1，最大值为100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

页面数据大小，默认为10，最大值为2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

排序字段

类型string

orderSort

排序方法

类型string

有效值

"ASC""DESC"

filters[0].key

筛选字段名称

类型string

filters[0].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

筛选值

类型object

filters[1].key

筛选字段名称

类型string

filters[1].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

筛选值

类型object

filters[2].key

筛选字段名称

类型string

filters[2].op

筛选条件（等于、不等于、大于等）

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

筛选值

类型object

infoScope

查询信息范围

类型string

有效值

"BASIC""DETAIL"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/tenant

试验场

授权

UserHttpBearer

变量

键

值

id

name

no

type

status

realNameStatus

locked

createdDate

applyCancelDate

lastLockDate

lockStartDate

lockEndDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

替换租户

PUT

/api/v1/tenant

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PUT

/api/v1/tenant

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

添加租户

POST

/api/v1/tenant

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/tenant

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

更新租户

PATCH

/api/v1/tenant

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/tenant

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

通过手机号注册添加租户

POST

/api/v1/tenant/signupByMobile

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

POST

/api/v1/tenant/signupByMobile

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

启用或禁用租户

PATCH

/api/v1/tenant/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/tenant/enabled

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

查询租户的详细信息

GET

/api/v1/tenant/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

租户ID

类型integer

必填

格式"int64"

响应

成功

Content-Type

*/*

"string"

GET

/api/v1/tenant/{id}

试验场

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

分布式锁或解锁租户

PATCH

/api/v1/tenant/locked

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

"string"

响应

成功

Content-Type

*/*

"string"

PATCH

/api/v1/tenant/locked

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---