文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Group/ 获取代码组信息
更新时间：2024-10-26 GMT+08:00
查看PDF
分享

获取代码组信息

功能介绍

获取代码组信息。

调试

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

URI

GET /v4/{project_id}/groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

group_id

是

Integer

代码组ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

creator_id

Integer

创建者id

project_id

String

项目id

created_at

String

创建时间

description

String

描述

full_name

String

代码组全名

ancestor_ids

Array Integer

代码组层级路径id

ancestor_names

Array String

代码组层级路径名称

id

Integer

代码组id

members_count

Integer

代码组成员计数

name

String

代码组名

repository_count

Integer

仓库计数

star_count

Integer

关注计数

starred

Boolean

是否关注

subgroup_count

Integer

子组计数

visibility

String

可见性, private public

sum

GroupSumDto

打开状态MR计数
表4 响应Body中GroupSumDto参数

参数

参数类型

描述

open_merge_requests_count

integer

打开状态MR计数

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应状态码

error_msg

String

响应错误信息

请求示例

GET https://{endpoint}/v4/{project_id}/groups/{group_id}

响应示例

状态码： 200

OK 
{
       creator_id: 9125
       project_id: 1a92b5c48d914f11893ca983d01a1d33
       description: ''
       full_name: 1a92b5c48d914f11893ca983d01a1d33 / q / 1 / 2
       ancestor_ids:
          - 2111665683
          - 2111665684
          - 2111665685
       ancestor_names:
          - q
          - '1'
          - '2'
       id: 2111665685
       members_count: 2
       name: '2'
       repository_count: 1
       star_count: 0
       starred: false
       subgroup_count: 0
       visibility: private
       sum:
         open_merge_requests_count: 0
}

状态码： 401

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

状态码

状态码

描述

200

OK

401

Unauthorized

错误码

请参见错误码。

父主题： Group

相关文档