文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 更新合并请求审核设置
更新时间:2025-09-28 GMT+08:00
分享

更新合并请求审核设置

功能介绍

更新合并请求审核设置

调试

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

URI

PUT /v4/repositories/{repository_id}/approver-settings/{setting_id}

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

setting_id

Integer

参数解释:

合并请求审核设置id。

取值范围:

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

参数解释:

设置主键id。

target

String

参数解释:

分支,可使用作为通配符使用,如:dev 指以dev开头的所有分支

target_type

String

设置类型,当前仅开放branch类型

枚举值:

  • branch

  • file

  • binary

is_use_approval

Boolean

是否为审核模式,审核模式:true 评分模式:false

approval_required_reviewers

Integer

最小检视人数

approval_required_approvers

Integer

最小审核人数

reset_approvals_on_push

Boolean

推送时是否重置审核门禁状态

reset_reviewers_on_push

Boolean

推送时是否重置检视门禁状态

approvers_from_project

Boolean

是否开启仅能从以下审核/检视人中追加审核人/检视人

append_reviewer_ids

Array of integers

追加检视人id列表

append_reviewers

Array of UserBasicDto objects

追加检视人实体列表

append_approver_ids

Array of integers

追加审核人id列表

append_approvers

Array of UserBasicDto objects

追加审核人实体列表

only_merge_when_pipeline_pass

Boolean

是否开启流水线门禁

assignee_ids

Array of integers

合并人id列表

assignees

Array of UserBasicDto objects

合并人实体列表

approver_ids

Array of integers

审核人id列表

approvers

Array of UserBasicDto objects

审核人实体列表

reviewer_ids

Array of integers

检视人id列表

reviewers

Array of UserBasicDto objects

检视人实体列表

表4 UserBasicDto

参数

是否必选

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

  • active: 可用账户。

  • blocked: 被锁定用户。

  • error: 未查询到该用户。

枚举值:

  • active

  • blocked

  • error

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释:

设置主键id。

target

String

参数解释:

分支,可使用作为通配符使用,如:dev 指以dev开头的所有分支

target_type

String

设置类型,当前仅开放branch类型

枚举值:

  • branch

  • file

  • binary

is_use_approval

Boolean

是否为审核模式,审核模式:true 评分模式:false

approval_required_reviewers

Integer

最小检视人数

approval_required_approvers

Integer

最小审核人数

reset_approvals_on_push

Boolean

推送时是否重置审核门禁状态

reset_reviewers_on_push

Boolean

推送时是否重置检视门禁状态

approvers_from_project

Boolean

是否开启仅能从以下审核/检视人中追加审核人/检视人

append_reviewer_ids

Array of integers

追加检视人id列表

append_reviewers

Array of UserBasicDto objects

追加检视人实体列表

append_approver_ids

Array of integers

追加审核人id列表

append_approvers

Array of UserBasicDto objects

追加审核人实体列表

only_merge_when_pipeline_pass

Boolean

是否开启流水线门禁

assignee_ids

Array of integers

合并人id列表

assignees

Array of UserBasicDto objects

合并人实体列表

approver_ids

Array of integers

审核人id列表

approvers

Array of UserBasicDto objects

审核人实体列表

reviewer_ids

Array of integers

检视人id列表

reviewers

Array of UserBasicDto objects

检视人实体列表

表6 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

  • active: 可用账户。

  • blocked: 被锁定用户。

  • error: 未查询到该用户。

枚举值:

  • active

  • blocked

  • error

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

PUT https://{endpoint}/v4/repository/2561032/approver-settings/330

{
  "id" : 330,
  "target_type" : "branch",
  "target" : "dev",
  "approval_required_approvers" : 0,
  "approval_required_reviewers" : 0,
  "reset_approvals_on_push" : true,
  "reset_reviewers_on_push" : true,
  "approvers_from_project" : false,
  "append_reviewer_ids" : [ ],
  "append_reviewers" : [ ],
  "append_approver_ids" : [ ],
  "append_approvers" : [ ],
  "only_merge_when_pipeline_pass" : true,
  "assignee_ids" : [ ],
  "assignees" : [ ],
  "approver_ids" : [ ],
  "approvers" : [ ],
  "reviewer_ids" : [ ],
  "reviewers" : [ ]
}

响应示例

状态码:201

OK

{
  "id" : 330,
  "target_type" : "branch",
  "target" : "dev",
  "is_use_approval" : true,
  "approval_required_approvers" : 0,
  "approval_required_reviewers" : 0,
  "reset_approvals_on_push" : true,
  "reset_reviewers_on_push" : true,
  "approvers_from_project" : false,
  "append_reviewer_ids" : [ ],
  "append_reviewers" : [ ],
  "append_approver_ids" : [ ],
  "append_approvers" : [ ],
  "only_merge_when_pipeline_pass" : true,
  "assignee_ids" : [ ],
  "assignees" : [ ],
  "approver_ids" : [ ],
  "approvers" : [ ],
  "reviewer_ids" : [ ],
  "reviewers" : [ ]
}

状态码: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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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.v4.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v4.*;
import com.huaweicloud.sdk.codehub.v4.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateMergeRequestApproverSettingSolution {

    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();
        UpdateMergeRequestApproverSettingRequest request = new UpdateMergeRequestApproverSettingRequest();
        request.withRepositoryId({repository_id});
        request.withSettingId({setting_id});
        MergeRequestApproverSettingResultDto body = new MergeRequestApproverSettingResultDto();
        body.withOnlyMergeWhenPipelinePass(true);
        body.withApproversFromProject(false);
        body.withResetReviewersOnPush(true);
        body.withResetApprovalsOnPush(true);
        body.withApprovalRequiredApprovers(0);
        body.withApprovalRequiredReviewers(0);
        body.withTargetType(MergeRequestApproverSettingResultDto.TargetTypeEnum.fromValue("branch"));
        body.withTarget("dev");
        body.withId("330");
        request.withBody(body);
        try {
            UpdateMergeRequestApproverSettingResponse response = client.updateMergeRequestApproverSetting(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
32
33
34
35
36
37
38
39
40
41
42
43
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodehub.v4 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 = UpdateMergeRequestApproverSettingRequest()
        request.repository_id = {repository_id}
        request.setting_id = {setting_id}
        request.body = MergeRequestApproverSettingResultDto(
            only_merge_when_pipeline_pass=True,
            approvers_from_project=False,
            reset_reviewers_on_push=True,
            reset_approvals_on_push=True,
            approval_required_approvers=0,
            approval_required_reviewers=0,
            target_type="branch",
            target="dev",
            id="330"
        )
        response = client.update_merge_request_approver_setting(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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/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.UpdateMergeRequestApproverSettingRequest{}
	request.RepositoryId = int32({repository_id})
	request.SettingId = int32({setting_id})
	onlyMergeWhenPipelinePassMergeRequestApproverSettingResultDto:= true
	approversFromProjectMergeRequestApproverSettingResultDto:= false
	resetReviewersOnPushMergeRequestApproverSettingResultDto:= true
	resetApprovalsOnPushMergeRequestApproverSettingResultDto:= true
	approvalRequiredApproversMergeRequestApproverSettingResultDto:= int32(0)
	approvalRequiredReviewersMergeRequestApproverSettingResultDto:= int32(0)
	targetTypeMergeRequestApproverSettingResultDto:= model.GetMergeRequestApproverSettingResultDtoTargetTypeEnum().BRANCH
	targetMergeRequestApproverSettingResultDto:= "dev"
	idMergeRequestApproverSettingResultDto:= "330"
	request.Body = &model.MergeRequestApproverSettingResultDto{
		OnlyMergeWhenPipelinePass: &onlyMergeWhenPipelinePassMergeRequestApproverSettingResultDto,
		ApproversFromProject: &approversFromProjectMergeRequestApproverSettingResultDto,
		ResetReviewersOnPush: &resetReviewersOnPushMergeRequestApproverSettingResultDto,
		ResetApprovalsOnPush: &resetApprovalsOnPushMergeRequestApproverSettingResultDto,
		ApprovalRequiredApprovers: &approvalRequiredApproversMergeRequestApproverSettingResultDto,
		ApprovalRequiredReviewers: &approvalRequiredReviewersMergeRequestApproverSettingResultDto,
		TargetType: &targetTypeMergeRequestApproverSettingResultDto,
		Target: &targetMergeRequestApproverSettingResultDto,
		Id: &idMergeRequestApproverSettingResultDto,
	}
	response, err := client.UpdateMergeRequestApproverSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档