文档首页/测试计划 CodeArts TestPlan/API参考/API/banner信息管理/查询租户用户总数 - ShowDomainUserCount
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询租户用户总数 - ShowDomainUserCount

功能介绍

查询租户用户总数

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/domain-user-count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

参数解释:

调用此接口的响应状态。

取值范围:

  • success，表示接口调用成功。

  • error，表示接口调用失败。

result

ResultValueDomainUserCount object

请求的返回的数据对象

error

ApiError object

错误信息。

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

表3 ResultValueDomainUserCount

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

DomainUserCount object

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多

表4 DomainUserCount

参数

参数类型

描述

domainUserTotal

Integer

domain_user_total

表5 ApiError

参数

参数类型

描述

code

String

响应码

reason

String

业务失败的提示内容

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

get https://{endpoint}/v4/projects/ab26ad085a594c9baac38216dff3409c/domain-user-count

响应示例

状态码：200

OK

{
  "value" : {
    "domainUserTotal" : 10
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：banner信息管理

相关文档