获取合并请求审核人列表
功能介绍
获取合并请求审核人列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/approval-approvers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
target_branch |
否 |
String |
参数解释: 目标分支。创建MR时,代码将要合入的分支。 |
source_branch |
否 |
String |
参数解释: 目标分支。创建MR时,变更代码所属的分支。 |
merge_request_iid |
否 |
Integer |
参数解释: 合并请求 iid。 取值范围: 1-2147483647 |
target_repository_id |
否 |
String |
参数解释: 目标仓库id。创建MR时,代码将要合入的仓库。 |
search |
否 |
String |
参数解释: 查询关键字,可模糊匹配用户名称、用户昵称、租户名称。 |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
参数解释: 可选审核人的总数 |
参数 |
参数类型 |
描述 |
---|---|---|
required_approvers_list |
Array of UserBasicDto objects |
参数解释: 必选审核人列表。 取值范围: 不涉及。 |
optional_approvers_list |
Array of UserBasicDto objects |
参数解释: 可选审核人列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 用户名称。 |
username |
String |
参数解释: 用户名。 |
state |
String |
用户状态 |
service_license_status |
Integer |
服务级权限状态 0:停用 1:启用 |
avatar_url |
String |
用户头像url |
avatar_path |
String |
用户头像路径 |
|
String |
用户邮箱 |
name_cn |
String |
用户中文名称 |
web_url |
String |
用户个人首页 |
nick_name |
String |
用户昵称 |
tenant_name |
String |
租户名称 |
error_message |
String |
参数解释: 部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/merge-requests/approval-approvers
响应示例
状态码:200
OK
[ { "optional_approvers_list" : [ { "id" : 9124, "name" : "dev_test", "username" : "c369c68f1ff84679b5a8ed904d8bff1c", "state" : "active", "avatar_url" : "", "avatar_path" : "", "email" : "", "name_cn" : "dev_test", "web_url" : "", "nick_name" : "dev", "tenant_name" : "test_tenant", "error_message" : "" }, { "id" : 9125, "name" : "dev_test1", "username" : "c369c68f1ff84679b5a8ed904d8bff11", "state" : "active", "avatar_url" : "", "avatar_path" : "", "email" : "", "name_cn" : "dev_test1", "web_url" : "", "nick_name" : "dev1", "tenant_name" : "test_tenant1", "error_message" : "" } ] }, { "required_approvers_list" : [ { "id" : 9126, "name" : "dev_test2", "username" : "c369c68f1ff84679b5a8ed904d8bff12", "state" : "active", "avatar_url" : "", "avatar_path" : "", "email" : "", "name_cn" : "dev_test2", "web_url" : "", "nick_name" : "dev2", "tenant_name" : "test_tenant2", "error_message" : "" }, { "id" : 9127, "name" : "dev_test3", "username" : "c369c68f1ff84679b5a8ed904d8bff13", "state" : "active", "avatar_url" : "", "avatar_path" : "", "email" : "", "name_cn" : "dev_test3", "web_url" : "", "nick_name" : "dev3", "tenant_name" : "test_tenant3", "error_message" : "" } ] } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。