文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 获取合并请求的可合入状态
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取合并请求的可合入状态

功能介绍

获取合并请求的可合入状态。

调试

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

URI

GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/mergeable-state-out

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647

merge_request_iid

是

Integer

参数解释：

合并请求 iid。

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

merge_request_id

Integer

参数解释：

合并请求id。

取值范围：

0-2147483647

state

Boolean

参数解释：

合并请求的可合入状态。

约束限制：

  • true，可合入。

  • false，不可合入。

conflict_passed

Boolean

参数解释：

合并请求冲突门禁是否通过。

约束限制：

  • true，不存在冲突。

  • false，存在冲突。

non_ff_passed

Boolean

参数解释：

合并请求是否需要变基。

约束限制：

  • true，不需变基。

  • false，需要变基。

merged_by_user_passed

Boolean

参数解释：

对当前用户是否有合入当前合并请求的权限判断。

约束限制：

  • true，有权限合入。

  • false，无权限合入。

work_in_progress_passed

Boolean

参数解释：

合并请求WIP门禁是否通过。

约束限制：

  • true，非WIP状态。

  • false，WIP状态。

resolve_discussion_passed

Boolean

参数解释：

合并请求检视意见门禁是否通过。

约束限制：

  • true，检视意见门禁通过。

  • false，检视意见门禁不通过。

ci_state_passed

Boolean

参数解释：

合并请求流水线门禁是否通过。

约束限制：

  • true，合并请求流水线门禁通过。

  • false，合并请求流水线门禁不通过。

merge_by_self_passed

Boolean

参数解释：

对当前用户是否有合入自己创建的合并请求的判断。

约束限制：

  • true，非自己创建的mr可以合入。

  • false，自己创建的mr不能合入。

can_force_merge

Boolean

参数解释：

当前用户是否可以强制合入当前合并请求。

约束限制：

  • true，可以强制合入。

  • false，不能强制合入。

vote_passed

Boolean

参数解释：

合并请求评分门禁是否通过。

约束限制：

  • true，评分门禁通过。

  • false，评分门禁不通过。

e2e_check_passed

Boolean

参数解释：

合并请求必须与CodeArts Req关联门禁是否通过。

约束限制：

  • true，合并请求必须与CodeArts Req关联门禁通过。

  • false，合并请求必须与CodeArts Req关联门禁不通过。

all_issues_passed

Boolean

参数解释：

合并请求所有E2E单号校验必须通过门禁是否通过。

约束限制：

  • true，合并请求所有E2E单号校验必须通过门禁通过。

  • false，合并请求所有E2E单号校验必须通过门禁不通过。

only_one_issue_passed

Boolean

参数解释：

合并请求只能关联一个单号门禁是否通过。

约束限制：

  • true，合并请求只能关联一个单号门禁通过。

  • false，合并请求只能关联一个单号门禁不通过。

approval_reviewers_required_passed

Boolean

参数解释：

合并请求检视门禁是否通过。

约束限制：

  • true，合并请求检视门禁通过。

  • false，合并请求检视门禁不通过。

approval_approvers_required_passed

Boolean

参数解释：

合并请求审核门禁是否通过。

约束限制：

  • true，合并请求审核门禁通过。

  • false，合并请求审核门禁不通过。

evaluation_passed

Boolean

参数解释：

合并请求星级评价门禁是否通过。

约束限制：

  • true，合并请求星级评价门禁通过。

  • false，合并请求星级评价门禁不通过。

状态码：401

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/1/merge-requests/1/mergeable-state-out

响应示例

状态码：200

OK

{
  "merge_request_id" : 1,
  "state" : true,
  "conflict_passed" : true,
  "non_ff_passed" : true,
  "merged_by_user_passed" : true,
  "work_in_progress_passed" : true,
  "resolve_discussion_passed" : true,
  "ci_state_passed" : true,
  "merge_by_self_passed" : true,
  "can_force_merge" : true,
  "vote_passed" : true,
  "e2e_check_passed" : true,
  "all_issues_passed" : true,
  "only_one_issue_passed" : true,
  "approval_reviewers_required_passed" : true,
  "approval_approvers_required_passed" : true,
  "evaluation_passed" : true
}

状态码：401

Unauthorized

{
  "error_code" : "CH.00000002",
  "error_msg" : "认证信息无法识别。"
}

状态码：404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

404

Not Found

错误码

请参见错误码。

父主题： MergeRequest

相关文档