文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Group/ 获取代码组下可添加的成员组
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取代码组下可添加的成员组

功能介绍

获取代码组下可添加的成员组

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v4/groups/{group_id}/user-groups/addable-list

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

Integer

参数解释：

代码组id，代码组首页，Group ID后的数字Id

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

取值范围：

字符串长度32。

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：201

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of UserGroupDto objects

参数解释：

成员组列表。
表5 UserGroupDto

参数

参数类型

描述

id

Integer

参数解释：

唯一标识id。

取值范围：

1-2147483647

name

String

参数解释：

名称。

取值范围：

字符串长度不少于1，不超过1000。

user_group_id

String

参数解释：

成员组id。

取值范围：

字符串长度不少于1，不超过1000。

project_id

String

参数解释：

项目id。

取值范围：

字符串长度不少于1，不超过1000。

tenant_id

String

参数解释：

租户id。

取值范围：

字符串长度不少于1，不超过1000。

group_type

String

参数解释：

代码组类型。

取值范围：

字符串长度不少于1，不超过1000。

member_count

Integer

参数解释：

成员数量。

取值范围：

1-2147483647

created_at

String

参数解释：

创建时间。

取值范围：

字符串长度不少于1，不超过1000。

updated_at

String

参数解释：

更新时间。

取值范围：

字符串长度不少于1，不超过1000。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/groups/{group_id}/user-groups/addable-list?offset=0&limit=20

响应示例

状态码：201

获取代码组下可添加的成员组

[ {
  "id" : 291,
  "name" : 3123,
  "user_group_id" : "a89f298bfcfa42a2804920cba6f6e5c2",
  "project_id" : "c65b44ca43b04961860e728cb91acfc6",
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "group_type" : "normal",
  "created_at" : "2025-06-17T01:45:28.904+08:00",
  "updated_at" : "2025-06-17T01:45:28.904+08:00"
} ]

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码：403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码

状态码

描述

201

获取代码组下可添加的成员组

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： Group

相关文档