文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Group/ 更新项目继承设置项
更新时间:2025-09-28 GMT+08:00
分享

更新项目继承设置项

功能介绍

更新项目继承设置项

调试

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

URI

PUT /v4/projects/{project_id}/settings-inherit-cfg

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

data

Array of ProjectSettingsInheritCfgDto objects

参数解释:

继承设置。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 ProjectSettingsInheritCfgDto

参数

是否必选

参数类型

描述

name

String

参数解释:

设置源类型。

约束限制:

不涉及。

取值范围:

  • protected_branches,保护分支设置。

  • protected_tags,保护Tag设置。

  • repository_settings,仓库设置。

  • push_rules,提交规则设置。

  • merge_requests,合并请求设置。

  • e2e_settings,E2E设置。

  • watermark,水印设置。

默认取值:

不涉及。

枚举值:

  • protected_branches

  • protected_tags

  • repository_settings

  • push_rules

  • merge_requests

  • e2e_settings

  • watermark

inherit_mod

String

参数解释:

继承设置。

约束限制:

不涉及。

取值范围:

  • force_inherit,强制继承配置。

  • custom,使用当前配置。

默认取值:

不涉及。

枚举值:

  • force_inherit

  • custom

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ProjectSettingsInheritCfgDto objects

项目继承设置列表

表6 ProjectSettingsInheritCfgDto

参数

参数类型

描述

name

String

参数解释:

设置源类型。

约束限制:

不涉及。

取值范围:

  • protected_branches,保护分支设置。

  • protected_tags,保护Tag设置。

  • repository_settings,仓库设置。

  • push_rules,提交规则设置。

  • merge_requests,合并请求设置。

  • e2e_settings,E2E设置。

  • watermark,水印设置。

默认取值:

不涉及。

枚举值:

  • protected_branches

  • protected_tags

  • repository_settings

  • push_rules

  • merge_requests

  • e2e_settings

  • watermark

inherit_mod

String

参数解释:

继承设置。

约束限制:

不涉及。

取值范围:

  • force_inherit,强制继承配置。

  • custom,使用当前配置。

默认取值:

不涉及。

枚举值:

  • force_inherit

  • custom

请求示例

更新项目继承设置项

PUT https://{endpoint}/v4/projects/3132f98fb2c44430ba68f356af3a8e0d/settings-inherit-cfg

{
  "data" : [ {
    "name" : "protected_branches",
    "inherit_mod" : "inherit"
  }, {
    "name" : "protected_tags",
    "inherit_mod" : "inherit"
  }, {
    "name" : "repository_settings",
    "inherit_mod" : "inherit"
  }, {
    "name" : "push_rules",
    "inherit_mod" : "inherit"
  }, {
    "name" : "merge_requests",
    "inherit_mod" : "inherit"
  }, {
    "name" : "e2e_settings",
    "inherit_mod" : "inherit"
  }, {
    "name" : "watermark",
    "inherit_mod" : "inherit"
  } ]
}

响应示例

状态码:200

项目继承设置列表

[ {
  "name" : "protected_branches",
  "inherit_mod" : "custom"
}, {
  "name" : "protected_tags",
  "inherit_mod" : "custom"
}, {
  "name" : "repository_settings",
  "inherit_mod" : "inherit"
}, {
  "name" : "push_rules",
  "inherit_mod" : "inherit"
}, {
  "name" : "merge_requests",
  "inherit_mod" : "inherit"
}, {
  "name" : "e2e_settings",
  "inherit_mod" : "inherit"
}, {
  "name" : "watermark",
  "inherit_mod" : "inherit"
} ]

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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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 UpdateProjectSettingsInheritCfgSolution {

    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();
        UpdateProjectSettingsInheritCfgRequest request = new UpdateProjectSettingsInheritCfgRequest();
        request.withProjectId("{project_id}");
        SettingsInheritCfgBodyApiDto body = new SettingsInheritCfgBodyApiDto();
        List<ProjectSettingsInheritCfgDto> listbodyData = new ArrayList<>();
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("protected_branches"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("protected_tags"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("repository_settings"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("push_rules"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("merge_requests"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("e2e_settings"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        listbodyData.add(
            new ProjectSettingsInheritCfgDto()
                .withName(ProjectSettingsInheritCfgDto.NameEnum.fromValue("watermark"))
                .withInheritMod(ProjectSettingsInheritCfgDto.InheritModEnum.fromValue("inherit"))
        );
        body.withData(listbodyData);
        request.withBody(body);
        try {
            UpdateProjectSettingsInheritCfgResponse response = client.updateProjectSettingsInheritCfg(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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# 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 = UpdateProjectSettingsInheritCfgRequest()
        request.project_id = "{project_id}"
        listDatabody = [
            ProjectSettingsInheritCfgDto(
                name="protected_branches",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="protected_tags",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="repository_settings",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="push_rules",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="merge_requests",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="e2e_settings",
                inherit_mod="inherit"
            ),
            ProjectSettingsInheritCfgDto(
                name="watermark",
                inherit_mod="inherit"
            )
        ]
        request.body = SettingsInheritCfgBodyApiDto(
            data=listDatabody
        )
        response = client.update_project_settings_inherit_cfg(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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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.UpdateProjectSettingsInheritCfgRequest{}
	request.ProjectId = "{project_id}"
	nameData:= model.GetProjectSettingsInheritCfgDtoNameEnum().PROTECTED_BRANCHES
	inheritModData:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData1:= model.GetProjectSettingsInheritCfgDtoNameEnum().PROTECTED_TAGS
	inheritModData1:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData2:= model.GetProjectSettingsInheritCfgDtoNameEnum().REPOSITORY_SETTINGS
	inheritModData2:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData3:= model.GetProjectSettingsInheritCfgDtoNameEnum().PUSH_RULES
	inheritModData3:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData4:= model.GetProjectSettingsInheritCfgDtoNameEnum().MERGE_REQUESTS
	inheritModData4:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData5:= model.GetProjectSettingsInheritCfgDtoNameEnum().E2E_SETTINGS
	inheritModData5:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	nameData6:= model.GetProjectSettingsInheritCfgDtoNameEnum().WATERMARK
	inheritModData6:= model.GetProjectSettingsInheritCfgDtoInheritModEnum().INHERIT
	var listDatabody = []model.ProjectSettingsInheritCfgDto{
        {
            Name: &nameData,
            InheritMod: &inheritModData,
        },
        {
            Name: &nameData1,
            InheritMod: &inheritModData1,
        },
        {
            Name: &nameData2,
            InheritMod: &inheritModData2,
        },
        {
            Name: &nameData3,
            InheritMod: &inheritModData3,
        },
        {
            Name: &nameData4,
            InheritMod: &inheritModData4,
        },
        {
            Name: &nameData5,
            InheritMod: &inheritModData5,
        },
        {
            Name: &nameData6,
            InheritMod: &inheritModData6,
        },
    }
	request.Body = &model.SettingsInheritCfgBodyApiDto{
		Data: &listDatabody,
	}
	response, err := client.UpdateProjectSettingsInheritCfg(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

项目继承设置列表

错误码

请参见错误码

相关文档