文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 获取仓库合并请求列表
更新时间：2024-11-08 GMT+08:00
查看PDF
分享

获取仓库合并请求列表

功能介绍

获取仓库的合并请求列表

调试

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

URI

GET /v2/repositories/{repository_id}/merge_request

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库短ID，对应产品界面的“Repository ID”。

约束限制：

必传。

取值范围：

0-2147483647

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

state

否

String

参数解释：

合并请求状态。

约束限制：

无。

取值范围：

取值为以下类型中的一种：

opened : 开启中的合并请求。

closed：已关闭的合并请求。

merged：已合并的合并请求。

locked：已锁定的合并请求。

all：所有状态的合并请求。

默认取值：

all：所有状态的合并请求

page

否

String

参数解释：

分页页数。

约束限制：

不涉及。

取值范围：

正整数范围内的有效页数。

默认取值：

1

per_page

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

0-2147483647

默认取值：

20

search

否

String

参数解释：

搜索合并中标题或描述包含的字符串。

约束限制：

不涉及。

取值范围：

字符串长度范围为[0,100]。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释：

响应错误码。

result

MergeResult object

参数解释：

响应结果。

status

String

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表5 Error

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

符合错误码格式字符串，长度[0,100]。

message

String

参数解释：

错误信息。

取值范围：

不涉及。
表6 MergeResult

参数

参数类型

描述

closed

Double

参数解释：

已关闭的合并请求数量。

取值范围：

0-2147483647

merge_requests

Array of MergeRequestsItem objects

参数解释：

合并请求列表详情。

merged

Double

参数解释：

已合并的合并请求数量。

取值范围：

0-2147483647

opened

Double

参数解释：

开启中的合并请求数量。

取值范围：

0-2147483647

total

Double

参数解释：

所有的合并请求数量。

取值范围：

0-2147483647
表7 MergeRequestsItem

参数

参数类型

描述

author

Author object

参数解释：

合并请求作者信息。

closed_at

String

参数解释：

合并请求的关闭时间。

created_at

String

参数解释：

合并请求的创建时间。

description

String

参数解释：

合并请求的描述信息。

devcloud_source_branch

String

参数解释：

合并请求的源分支名。

id

Double

参数解释：

合并请求的ID。

取值范围：

0-2147483647

iid

Double

参数解释：

当前仓库内合并请求的序列ID。

取值范围：

0-2147483647

merge_request_assignee_list

Array of Author objects

参数解释：

合并请求的检视人信息。

merge_status

String

参数解释：

合并请求是否可以合并。

取值范围：

can_be_merged：可以合并。

cannot_be_merged：不可以合并。

unchecked：未检查。

cannot_be_merged_recheck: 不可合并，检查中。

source_branch

String

参数解释：

合并请求的源分支名。

state

String

参数解释：

合并请求状态。

取值范围：

取值为以下类型中的一种：

opened : 开启中的合并请求。

closed：已关闭的合并请求。

merged：已合并的合并请求。

locked：已锁定的合并请求。

target_branch

String

参数解释：

合并请求的目标分支名。

title

String

参数解释：

合并请求的标题。

updated_at

String

参数解释：

合并请求的最后更新时间。
表8 Author

参数

参数类型

描述

id

Double

参数解释：

用户ID。

name

String

参数解释：

用户名称。

state

String

参数解释：

用户状态。

username

String

参数解释：

用户IAM ID。

avatar_url

String

参数解释：

头像url。

web_url

String

参数解释：

web url。

请求示例

GET https://{endpoint}/v2/repositories/907199/merge_request

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 1,
    "merge_requests" : [ {
      "iid" : 1,
      "description" : "merge \"branch123\" into \"master\"\n新建文件 dsadsad11",
      "created_at" : "2021-12-08T16:34:49.000+08:00",
      "title" : "tesafrds.",
      "source_branch" : "branch123",
      "updated_at" : "2021-12-08T16:39:24.000+08:00",
      "id" : 6670,
      "state" : "opened",
      "closed_at" : "2021-12-08T16:34:50.000+08:00",
      "author" : {
        "name" : "repo",
        "id" : 1234,
        "state" : "active",
        "username" : "e0c068bf68c44bfab87b763ff85da277"
      },
      "target_branch" : "master",
      "merge_status" : "can_be_merged",
      "devcloud_source_branch" : "branch123",
      "merge_request_assignee_list" : [ {
        "name" : "示例账号",
        "id" : 3333,
        "state" : "active",
        "username" : "a618e34bd5704be3ae3395dfede06041"
      }, {
        "name" : "示例账号",
        "id" : 6747,
        "state" : "active",
        "username" : "42dd0277cfb048dea856e4ee352e937d"
      } ]
    } ],
    "merged" : 0,
    "closed" : 0,
    "opened" : 1
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档