获取合并请求检视人列表
功能介绍
获取合并请求检视人列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/approval-reviewers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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_reviewers_list |
Array of UserBasicDto objects |
参数解释: 必选检视人列表。 取值范围: 不涉及。 |
optional_reviewers_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-reviewers
响应示例
状态码:200
OK
[ { "optional_reviewers_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_reviewers_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" : "您没有操作权限,请升级权限后重试。" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codehub.v3.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v3.*; import com.huaweicloud.sdk.codehub.v3.model.*; public class ListMergeRequestReviewersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListMergeRequestReviewersRequest request = new ListMergeRequestReviewersRequest(); request.withRepositoryId("{repository_id}"); try { ListMergeRequestReviewersResponse response = client.listMergeRequestReviewers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodehub.v3.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListMergeRequestReviewersRequest() request.repository_id = "{repository_id}" response = client.list_merge_request_reviewers(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListMergeRequestReviewersRequest{} request.RepositoryId = "{repository_id}" response, err := client.ListMergeRequestReviewers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。