ListMergeRequests - 查询合并请求列表

查询合并请求列表,支持分页、排序和筛选。 该API能同时查询旧版和新版的合并请求,若没有使用过旧版合并请求,或者已经没有旧版合并请求数据,那么直接忽略返回信息中跟旧版合并请求相关的字段。

接口说明

该接口需要确保当前企业已经在使用新版 MR,具体可看当前企业的合并请求页面是否已是新版本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v4/projects/merge_requests/advanced_search

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

60de7a6852743a5162b5f957
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
pagelong

页码,默认值为 1,从第 1 页开始

1
pageSizelong

每页大小,默认值为 20,取值范围【1,100】

10
groupIdsstring

代码组 ID,支持多个 ID,以逗号分隔

889910, 889911
projectIdsstring

代码库 ID,支持多个 ID,以逗号分隔

2308912, 2308913
authorIdsstring

创建人阿里云账号 ID,支持多个,以逗号分隔

1234567890
reviewerIdsstring

评审人阿里云账号 ID,支持多个,以逗号分隔

1234567890123
statestring

合并请求状态,默认查询所有状态

  • opened:已开启,包含评审中、待合并、待开发状态
  • closed:已关闭
  • merged:已合并
  • all:所有,若是 all,可以不用传值;其他无效字符,也默认查询所有。
opened
searchstring

搜索关键字,匹配合并请求的标题

test-search
orderBystring

排序字段,默认值为 updated_at

  • created_at:创建时间
  • updated_at:更新时间

若传入其他无效字符,默认使用 updated_at

updated_at
sortstring

排序方式,默认值为 desc

  • desc:降序
  • asc:升序
desc
filterstring

该字段主要用于过滤新旧版本的合并请求,默认不过滤,同时获取新旧版本的内容,若是一直使用新版合并请求,可忽略该参数。可选值:

  • new:仅查询新版合并请求
  • old:仅查询旧版合并请求
new
labelIdsstring

类标 ID 列表,多个 ID 以逗号分隔

b5b5738b94954bc6aa5a293316ed1d24
createdBeforestring

起始创建时间

说明 ISO 8601 格式,如 2019-03-15T08:00:00Z,大小比较为 "大于等于"
2019-03-15T08:00:00Z
createdAfterstring

截止创建时间

说明 ISO 8601 格式,如 2019-03-15T08:00:00Z,大小比较为 "小于"
说明 创建时间范围:[createdBefore, createdAfter),即左闭右开区间
2019-03-15T08:00:00Z

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

""
successboolean

调用是否成功

true
totallong

总记录数

30
resultarray<object>

返回结果列表

object

合并请求信息

newMergeRequestIdentifierboolean

新旧版合并请求的标识,true 表示新版,false 表示旧版

true
projectIdlong

代码库 ID

2369234
idlong

旧版合并请求的 ID,若当前为新版合并请求,那么该值为空

1
iidlong

合并请求局部 ID,表示代码库下的第几个合并请求;若是新版合并请求,那么该值为空

1
mrBizIdstring

新版合并请求的唯一 ID,仅新版合并请求会有该值

bca90244c4b749e0b109df52ac0eb570
localIdlong

合并请求局部 ID,表示代码库下的第几个合并请求,新版合并请求字段

2
titlestring

合并请求标题

test-合并请求标题
descriptionstring

合并请求描述内容

描述信息的具体内容
statestring

旧版合并请求状态

  • opened:已开启
  • reopened:重新打开
  • closed:已关闭
  • accepted:评审通过(未合并)
  • merged:评审通过(已合并)
  • locked:合并锁定中
opened
newVersionStatestring

新版合并请求状态

  • UNDER_DEV:开发中
  • UNDER_REVIEW:评审中
  • TO_BE_MERGED:待合并
  • CLOSED:已关闭
  • MERGED:已合并
UNDER_REVIEW
createdAtstring

创建时间

2022-03-18 14:24:54
updatedAtstring

更新时间

2022-03-18 14:24:54
sourceBranchstring

源分支

test-merge-source-branch
targetBranchstring

目标分支

test-merge-target-branch
authorobject

作者信息

idlong

Codeup 的用户 ID

19927
namestring

用户名称

test-codeup
usernamestring

用户登录名

root-test-codeup
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
emailstring

用户邮箱

username@example.com
reviewersarray<object>

评审人信息列表

object

评审人信息

idlong

Codeup 的用户 ID

43127
namestring

用户名称

test-review-user
usernamestring

用户登录名

root-test-review-user
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

评审人的头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
emailstring

用户邮箱

username@example.com
statusstring

评审人状态

  • approved:已同意
  • comment:发表过评审
  • pending:还未评审过
approved
reviewTimestring

评审人评审完成时间

说明 仅在新版合并请求才有效,且评审人需要完成评审后,该字段才确保存在,否则为空。
2022-03-18 14:24:54
hasReviewedboolean

评审人是否已经评审过

false
hasCommentedboolean

评审人是否发表过评论

true
reviewOpinionStatusstring

评审意见,若未评审则为空

  • PASS:通过
  • NOT_PASS:暂不通过
PASS
subscribersarray<object>

订阅人信息列表

object

订阅人信息

idlong

Codeup 用户 ID

1876119
namestring

用户名称

test-subscriber
usernamestring

用户登录名

root-test-subscriber
statestring

用户状态,可选值:

  • active - 可用状态
  • blocked - 废弃或不可用
active
avatarUrlstring

头像地址

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100
emailstring

用户邮箱

username@example.com
sourceProjectIdlong

源代码库 ID

2876119
targetProjectIdlong

目标库 ID

2876119
workInProgressboolean

是否在开发中

false
detailUrlstring

合并请求详情地址

xxx
webUrlstring

页面访问时的 URL

""
sshUrlstring

代码库的 SSH 克隆地址

git@xxx:xxx/test/test.git
creationMethodstring

创建方式

  • WEB:网页 UI 创建
  • COMMAND_LINE:命令行创建
WEB
sourceTypestring

若是旧版合并请求,枚举值为

  • BRANCH:分支
  • COMMIT:提交

若是新版合并请求,枚举值为

  • BRANCH:分支
  • REF:提交或者引用评审
BRANCH
targetTypestring

目标类型通常为 BRANCH

BRANCH
nameWithNamespacestring

代码库完整名称(含完整组名称)

codeup-test-org / test-create-group (斜杠两侧有空格)
supportMergeFFOnlyboolean

是否支持 fast-forward-only 合并方式

true
labelsarray<object>

类标列表

object

类标信息

idstring

类标 ID,唯一标识

b5b5738b94954bc6aa5a293316ed1d24
namestring

类标名称

新特性
colorstring

类标颜色

#006AD4
descriptionstring

类标描述

新的特性或需求
mergedRevisionstring

合并版本(Commit SHA)

1a072f5367c21f9de3464b8c0ee8546e47764d2d

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "\"\"",
  "success": true,
  "total": 30,
  "result": [
    {
      "newMergeRequestIdentifier": true,
      "projectId": 2369234,
      "id": 1,
      "iid": 1,
      "mrBizId": "bca90244c4b749e0b109df52ac0eb570",
      "localId": 2,
      "title": "test-合并请求标题",
      "description": "描述信息的具体内容\n",
      "state": "opened",
      "newVersionState": "UNDER_REVIEW",
      "createdAt": "2022-03-18 14:24:54",
      "updatedAt": "2022-03-18 14:24:54",
      "sourceBranch": "test-merge-source-branch",
      "targetBranch": "test-merge-target-branch",
      "author": {
        "id": 19927,
        "name": "test-codeup",
        "username": "root-test-codeup",
        "state": "active",
        "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
        "email": "username@example.com"
      },
      "reviewers": [
        {
          "id": 43127,
          "name": "test-review-user",
          "username": "root-test-review-user",
          "state": "active",
          "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
          "email": "username@example.com",
          "status": "approved",
          "reviewTime": "2022-03-18 14:24:54",
          "hasReviewed": false,
          "hasCommented": true,
          "reviewOpinionStatus": "PASS"
        }
      ],
      "subscribers": [
        {
          "id": 1876119,
          "name": "test-subscriber",
          "username": "root-test-subscriber",
          "state": "active",
          "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
          "email": "username@example.com"
        }
      ],
      "sourceProjectId": 2876119,
      "targetProjectId": 2876119,
      "workInProgress": false,
      "detailUrl": "xxx",
      "webUrl": "\"\"",
      "sshUrl": "git@xxx:xxx/test/test.git",
      "creationMethod": "WEB",
      "sourceType": "BRANCH",
      "targetType": "BRANCH",
      "nameWithNamespace": "codeup-test-org / test-create-group (斜杠两侧有空格)",
      "supportMergeFFOnly": true,
      "labels": [
        {
          "id": "b5b5738b94954bc6aa5a293316ed1d24",
          "name": "新特性",
          "color": "#006AD4",
          "description": "新的特性或需求"
        }
      ],
      "mergedRevision": "1a072f5367c21f9de3464b8c0ee8546e47764d2d"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-23OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-11OpenAPI 返回结构发生变更查看变更详情