文档首页/ 需求管理 CodeArts Req/ API参考/ API/ 项目成员/ 获取指定项目的成员用户列表
更新时间：2025-08-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指定项目的成员用户列表

功能介绍

获取项目成员列表。

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/members

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

正则表达式，[A-Za-z0-9]{32}。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

是

Integer

参数解释：

条数，每页显示查询的数量。

约束限制：

不涉及。

取值范围：

最小值：1，最大值：1000。

默认取值：

10

offset

是

Integer

参数解释：

分页索引，偏移量，offset是limit的整数倍数。

约束限制：

从0开始。

取值范围：

最小值：0，最大值：10000。

默认取值：

缺省值：0

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

members

Array of members objects

参数解释：

项目成员列表。

total

Integer

参数解释：

总数。

取值范围：

不涉及。
表4 members

参数

参数类型

描述

domain_id

String

参数解释：

租户id。

取值范围：

不涉及。

domain_name

String

参数解释：

租户名。

取值范围：

不涉及。

user_id

String

参数解释：

用户id。用户在系统中的唯一编号。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。

user_num_id

Integer

参数解释：

创建人numId。用户int类型的编号，有部分删除接口需要。

取值范围：

不涉及。

role_id

Integer

参数解释：

成员角色id，取值范围枚举值中的key。

取值范围：

-1（ 项目创建者）;

3 （项目经理）;

4（ 开发人员）;

5 （测试经理）;

6（ 测试人员）;

7 （参与者）;

8 （浏览者）;

9 （运维经理）。

nick_name

String

参数解释：

用户昵称。

取值范围：

不涉及。

role_name

String

参数解释：

用户角色，取值范围枚举值中的value。

取值范围：

项目创建者、项目经理、 开发人员、测试经理、测试人员、参与者、浏览者、运维经理等。

user_type

String

参数解释：

用户类型。

取值范围：

User（iam用户）；

Federation（联邦账号）；

forbidden

Integer

参数解释：

是否是禁用账号。

取值范围：

1 禁用账号， 0非禁用账号。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/members

GET {{url}}/v4/projects/ac069b11a3524163ad6348953e2fe93e/members?limit=2&offset=0

{
    "members": [
        {
            "domain_id": "4e919d73499648e3b0292cd3cbef806a",
            "domain_name": "devcloud_devcloud_s00404480_01",
            "user_num_id": 4091,
            "user_id": "a360371833bf4c558f796fd707b44daf",
            "user_name": "devcloud_devcloud_s00404480_01",
            "nick_name": "张三丰1",
            "role_id": -1,
            "role_name": "项目创建者",
            "forbidden": 1,
            "user_type": null
        },
        {
            "domain_id": "4e919d73499648e3b0292cd3cbef806a",
            "domain_name": "devcloud_devcloud_s00404480_01",
            "user_num_id": 9367,
            "user_id": "09d25f5d3f80d2881fd7c008ecf1622b",
            "user_name": "child01",
            "nick_name": "child01update1",
            "role_id": 3,
            "role_name": "项目经理",
            "forbidden": 0,
            "user_type": null
        }
    ],
    "total": 8
}

响应示例

状态码：200

OK

{
  "members" : [ {
    "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
    "domain_name" : "demo_user_name",
    "user_id" : "a360371833bf4c558f796fd707b44daf",
    "user_name" : "demo_user_name",
    "user_num_id" : 4097,
    "role_id" : 7,
    "nick_name" : "name",
    "role_name" : "项目创建者",
    "user_type" : "User",
    "forbidden" : 0
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 项目成员

相关文档