查询合并请求列表,支持分页、排序和筛选。 该API能同时查询旧版和新版的合并请求,若没有使用过旧版合并请求,或者已经没有旧版合并请求数据,那么直接忽略返回信息中跟旧版合并请求相关的字段。
接口说明
该接口需要确保当前企业已经在使用新版 MR,具体可看当前企业的合并请求页面是否已是新版本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /api/v4/projects/merge_requests/advanced_search
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 60de7a6852743a5162b5f957 |
accessToken | string | 否 | 个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 | f0b1e61db5961df5975a93f9129d2513 |
page | long | 否 | 页码,默认值为 1,从第 1 页开始 | 1 |
pageSize | long | 否 | 每页大小,默认值为 20,取值范围【1,100】 | 10 |
groupIds | string | 否 | 代码组 ID,支持多个 ID,以逗号分隔 | 889910, 889911 |
projectIds | string | 否 | 代码库 ID,支持多个 ID,以逗号分隔 | 2308912, 2308913 |
authorIds | string | 否 | 创建人阿里云账号 ID,支持多个,以逗号分隔 | 1234567890 |
reviewerIds | string | 否 | 评审人阿里云账号 ID,支持多个,以逗号分隔 | 1234567890123 |
state | string | 否 | 合并请求状态,默认查询所有状态
| opened |
search | string | 否 | 搜索关键字,匹配合并请求的标题 | test-search |
orderBy | string | 否 | 排序字段,默认值为 updated_at
若传入其他无效字符,默认使用 updated_at | updated_at |
sort | string | 否 | 排序方式,默认值为 desc
| desc |
filter | string | 否 | 该字段主要用于过滤新旧版本的合并请求,默认不过滤,同时获取新旧版本的内容,若是一直使用新版合并请求,可忽略该参数。可选值:
| new |
labelIds | string | 否 | 类标 ID 列表,多个 ID 以逗号分隔 | b5b5738b94954bc6aa5a293316ed1d24 |
createdBefore | string | 否 | 起始创建时间 说明
ISO 8601 格式,如 2019-03-15T08:00:00Z,大小比较为 "大于等于"
| 2019-03-15T08:00:00Z |
createdAfter | string | 否 | 截止创建时间 说明
ISO 8601 格式,如 2019-03-15T08:00:00Z,大小比较为 "小于"
说明
创建时间范围:[createdBefore, createdAfter),即左闭右开区间
| 2019-03-15T08:00:00Z |
返回参数
示例
正常返回示例
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-29 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-23 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |