文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 用户信息管理/ 获取项目关联用户详情列表
更新时间:2025-07-24 GMT+08:00
分享

获取项目关联用户详情列表

功能介绍

获取项目关联用户详情列表

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

key_word

String

关键词

page_no

Integer

页数

page_size

Integer

页大小

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListProjectUserInfoVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

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

表4 ResultValueListProjectUserInfoVo

参数

参数类型

描述

total

Integer

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

value

Array of ProjectUserInfoVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多

表5 ProjectUserInfoVo

参数

参数类型

描述

user_id

String

用户id

domain_id

String

租户ID

role_id

String

权限id

user_name

String

用户名称

nick_name

String

用户别名

role_name

String

权限名称

project_id

String

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

region_id

String

区域id

short_id

String

用户短id

enable_internal_advanced

Boolean

是否启用国内站增强包

enable_internal_parallel

Boolean

是否启用国内站并发包

enable_oversea_basic

Boolean

是否启用国际站基础包

enable_oversea_professional

Boolean

是否启用国际站增强包

表6 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

get https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/users?key_word="1233"&page_no=1&page_size=10

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "user_id" : "545464",
      "domain_id" : "asd11222",
      "user_name" : "新用户01",
      "project_id" : "75681cbb7c324e15a9eb8ee74a96a474"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档