Query Tenants

Query tenants.

Request URL

POST {base_url}/uc-tenant/api/v1/tenants/search-page

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.

Body parameters


Parameter	Required	Type	Description
pageSize	Yes	Integer	The number of records to retrieve per page.
pageNumber	Yes	Integer	The page number to retrieve.
sorts	No	Array<Sort_Condition>	The sort conditions.
keyword	No	String	The keyword used to search for tenants.
name	No	String	The name of the tenant.
statusList	No	Array<String>	The tenant status. Valid value: `ACTIVE`: The tenant is active. `SUSPENDED`: The tenant is suspended.
description	No	String	The description of the tenant.
owner	No	String	The username of the tenant owner.
creator	No	String	The username of the tenant creator.
createTimeStart	No	Integer	The start of the tenant creation time range, in Unix timestamp format (milliseconds).
createTimeEnd	No	Integer	The end of the tenant creation time range, in Unix timestamp format (milliseconds).
ucId	No	Integer	The UC ID of the company to which the tenant owner belongs.
idList	No	Array<Integer>	The tenant IDs.
brandName	No	String	The brand name.
oemId	No	Integer	The OEM ID. Note: You can obtain the ID using the Get the OEM ID Configuration interface.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by. Valid value: `name` `owner` `createTime` `maxUsers` `maxConcurrentCalls` `activeCalls`
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Tenant_Information>	The tenant information.

Tenant_Information


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
total	Integer	The total number of tenants that match the search conditions.
results	Array<Tenant_Detail>	The list of tenants that match the search conditions.

Tenant_Detail


Parameter	Type	Description
id	String	The ID of the tenant.
ucId	String	The UC ID of the company to which the tenant owner belongs.
status	String	The status of the tenant. `ACTIVE`: The tenant is active. `SUSPENDED`: The tenant is suspended.
name	String	The name of the tenant.
description	String	The description of the tenant.
maxUsers	Integer	The maximum number of users.
usedUsers	Integer	The number of users currently in use.
maxConcurrentCalls	Integer	The maximum number of concurrent calls.
activeCalls	Integer	The current number of active calls.
owner	String	The owner of the tenant.
creator	String	The creator of the tenant.
createTime	Integer	The time when the tenant was created, in Unix timestamp format (milliseconds).
brandId	String	The brand ID.
brandName	String	The brand name.
oemId	Integer	The OEM ID.

Example

Request example

POST /uc-tenant/api/v1/tenants/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTk4NTEyOSwiaWF0IjoxNzkxOTYzNTI5LCJqdGkiOiI4OWEzZGNjZi0xODUwLTQ4ODQtOGFmOS1mNGFmY2I2MzljNWIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.M6uGO4Ocer4JKJLJ5ZIafLRIs5yqPMa0Y_RIiwQTb2bWsr5DViU0jgbjca91VukjmGNplQV0U0QoX17I6Y6EhytUkHWTjW1FkEWJiu7CPCob_qDcta9RyT-Hio36HViBsoU1fewmFyufrl5Li1KLxnuREIWklyImMH4-JJwsni7-19l537NIog150PtePm5RalOLCcvE0a4DbD9MV7aPaHaBfWhxXgZJvAB_13tG_ELkVny7Mpwcui-b1kGeis9gWL878M0ZpIJ20OHk578BeL60PDh3IiInYeQMrmCT2p04KQqDyFI6KuIz85I85a6bJKa9ntzJJv3q-s9lBZuELw
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 20
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "total": 3,
    "results": [
      {
        "id": "2110275026322784258",
        "ucId": "3076913644890832896",
        "status": "ACTIVE",
        "name": "ait-doc-test-03",
        "description": "API doc test tenant",
        "maxUsers": 10,
        "usedUsers": 0,
        "maxConcurrentCalls": 10,
        "activeCalls": 0,
        "owner": "ADMIN / example@outlook.com",
        "creator": "DD li(example@outlook.com)",
        "createTime": 1791963748152,
        "brandId": "2089256397261770753",
        "brandName": "Colorbrand",
        "oemId": 0
      },
      {
        "id": "2110275024254992385",
        "ucId": "3076913644890832896",
        "status": "ACTIVE",
        "name": "ait-doc-test-02",
        "description": "API doc test tenant",
        "maxUsers": 10,
        "usedUsers": 0,
        "maxConcurrentCalls": 10,
        "activeCalls": 0,
        "owner": "ADMIN / example@outlook.com",
        "creator": "DD li(example@outlook.com)",
        "createTime": 1791963747667,
        "brandId": "2089256397261770753",
        "brandName": "Colorbrand",
        "oemId": 0
      },
      {
        "id": "2110275022208172034",
        "ucId": "3076913644890832896",
        "status": "ACTIVE",
        "name": "ait-doc-test-01",
        "description": "API doc test tenant",
        "maxUsers": 10,
        "usedUsers": 0,
        "maxConcurrentCalls": 10,
        "activeCalls": 0,
        "owner": "ADMIN / example@outlook.com",
        "creator": "DD li(example@outlook.com)",
        "createTime": 1791963747173,
        "brandId": "2089256397261770753",
        "brandName": "Colorbrand",
        "oemId": 0
      }
    ]
  },
  "requestId": "465338756a89ae7c3e33d2120fe799cd",
  "code": "200",
  "message": "SUCCESS"
}