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

创建代码组合并请求审核设置

功能介绍

创建代码组合并请求审核设置

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

Integer

参数解释：

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

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

target

否

String

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

is_use_approval

否

Boolean

为false时，“最小检视人数”，“最小审核人数”，“重新推送代码时重置审核人”，“重新推送代码时重置检视人”，“仅能从以下审核人/检视人中追加审核人/检视人”置为默认

approval_required_approvers

否

Integer

最小审核人数

approval_required_reviewers

否

Integer

最小检视人数

reset_approvals_on_push

否

Boolean

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

reset_reviewers_on_push

否

Boolean

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

approvers_from_project

否

Boolean

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

append_reviewer_ids

否

Array of integers

追加检视人人用户id列表

append_approver_ids

否

Array of integers

追加审核人用户id列表

only_merge_when_pipeline_pass

否

Boolean

是否开启流水线门禁

assignee_ids

否

Array of integers

合并人用户id列表

approver_ids

否

Array of integers

审核人用户id列表

reviewer_ids

否

Array of integers

检视人用户id列表

响应参数

状态码：201

表4 响应Body参数

参数

参数类型

描述

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

检视人实体列表
表5 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

参数解释：

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

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/group/2561032/approver-settings

{
  "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_approver_ids" : [ ],
  "only_merge_when_pipeline_pass" : true,
  "assignee_ids" : [ ],
  "approver_ids" : [ ],
  "reviewer_ids" : [ ]
}

响应示例

状态码：201

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" : [ ]
}

状态码：401

Unauthorized

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

状态码：403

Bad Request

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

状态码

状态码

描述

201

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： MergeRequest

相关文档