文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 获取代码组合并请求审核设置列表
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取代码组合并请求审核设置列表

功能介绍

获取代码组合并请求审核设置列表

调试

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

URI

GET /v4/groups/{group_id}/approver-settings

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

Integer

参数解释：

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

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

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万。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of MergeRequestApproverSettingResultDto objects

审核策略设置
表5 MergeRequestApproverSettingResultDto

参数

参数类型

描述

id

String

参数解释：

设置主键id。

target

String

参数解释：

分支，可使用作为通配符使用，如：dev 指以dev开头的所有分支

target_type

String

设置类型，当前仅开放branch类型

枚举值：

  • branch

  • file

  • binary

is_use_approval

Boolean

是否为审核模式，审核模式：true 评分模式：false

approval_required_reviewers

Integer

最小检视人数

approval_required_approvers

Integer

最小审核人数

reset_approvals_on_push

Boolean

推送时是否重置审核门禁状态

reset_reviewers_on_push

Boolean

推送时是否重置检视门禁状态

approvers_from_project

Boolean

是否开启仅能从以下审核/检视人中追加审核人/检视人

append_reviewer_ids

Array of integers

追加检视人id列表

append_reviewers

Array of UserBasicDto objects

追加检视人实体列表

append_approver_ids

Array of integers

追加审核人id列表

append_approvers

Array of UserBasicDto objects

追加审核人实体列表

only_merge_when_pipeline_pass

Boolean

是否开启流水线门禁

assignee_ids

Array of integers

合并人id列表

assignees

Array of UserBasicDto objects

合并人实体列表

approver_ids

Array of integers

审核人id列表

approvers

Array of UserBasicDto objects

审核人实体列表

reviewer_ids

Array of integers

检视人id列表

reviewers

Array of UserBasicDto objects

检视人实体列表
表6 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释：

用户id。

取值范围：

1-2147483647

name

String

参数解释：

用户名称。

username

String

参数解释：

用户名。

state

String

用户状态

service_license_status

Integer

服务级权限状态 0：停用 1：启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释：

部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

无

响应示例

状态码：200

OK

[ {
  "id" : 330,
  "target_type" : "branch",
  "target" : "dev",
  "is_use_approval" : true,
  "approval_required_approvers" : 0,
  "approval_required_reviewers" : 0,
  "reset_approvals_on_push" : true,
  "reset_reviewers_on_push" : true,
  "approvers_from_project" : false,
  "append_reviewer_ids" : [ ],
  "append_reviewers" : [ ],
  "append_approver_ids" : [ ],
  "append_approvers" : [ ],
  "only_merge_when_pipeline_pass" : true,
  "assignee_ids" : [ ],
  "assignees" : [ ],
  "approver_ids" : [ ],
  "approvers" : [ ],
  "reviewer_ids" : [ ],
  "reviewers" : [ ]
} ]

状态码：400

Bad Request

{
  "error_code" : "CH.00405011",
  "error_msg" : "错误请求"
}

状态码：401

Unauthorized

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： MergeRequest

相关文档