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

获取代码组继承设置项

功能介绍

获取代码组继承设置项

调试

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

URI

GET /v4/groups/{group_id}/settings-inherit-cfg

表1 路径参数

参数

是否必选

参数类型

描述

group_id

Integer

参数解释:

代码组id,代码组首页,Group ID后的数字Id

取值范围:

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

can_update

Boolean

参数解释:

是否可用。

id

Integer

参数解释:

记录id。

取值范围:

1-2147483647

product_id

String

参数解释:

项目id。

取值范围:

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

namespace_id

Integer

参数解释:

代码组id。

取值范围:

1-2147483647

parent_id

Integer

参数解释:

父id。

取值范围:

1-2147483647

ownership

Integer

参数解释:

排序id。

取值范围:

1-2147483647

pbi

Integer

参数解释:

排序id。

取值范围:

1-2147483647

protected_branches

Integer

参数解释:

保护分支策略。

取值范围:

1-2147483647

protected_tags

Integer

参数解释:

保护tag策略。

取值范围:

1-2147483647

push_rules

Integer

参数解释:

推送规则策略。

取值范围:

1-2147483647

change_requests

Integer

参数解释:

cr策略。

取值范围:

1-2147483647

custom_ctrl_items

Integer

参数解释:

排序id。

取值范围:

1-2147483647

reviews

Integer

参数解释:

排序id。

取值范围:

1-2147483647

issues

Integer

参数解释:

issue继承模式。

取值范围:

1-2147483647

cr_evaluation

Integer

参数解释:

排序id。

取值范围:

1-2147483647

e2e_settings

Integer

参数解释:

e2e策略。

取值范围:

1-2147483647

committer_settings

Integer

参数解释:

提交策略。

取值范围:

1-2147483647

webhook_settings

Integer

参数解释:

webhook策略。

取值范围:

1-2147483647

stream_event_settings

Integer

参数解释:

排序id。

取值范围:

1-2147483647

pipeline_settings

Integer

参数解释:

排序id。

取值范围:

1-2147483647

issue_templates

Integer

参数解释:

issue模板继承模式。

取值范围:

1-2147483647

cr_comment_templates

Integer

参数解释:

排序id。

取值范围:

1-2147483647

merge_requests

Integer

参数解释:

排序id。

取值范围:

1-2147483647

mr_branch_policies

Integer

参数解释:

合并请求策略。

取值范围:

1-2147483647

repository_settings

Integer

参数解释:

仓库策略。

取值范围:

1-2147483647

deploy_keys

Integer

参数解释:

部署密钥策略。

取值范围:

1-2147483647

watermark

Integer

参数解释:

水印策略。

取值范围:

1-2147483647

created_at

String

参数解释:

创建时间。

update_at

String

参数解释:

更新时间。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/groups/{group_id}/settings-inherit-cfg

响应示例

状态码:200

Get Group Inheritance Settings

{
  "can_update" : null,
  "id" : 352996,
  "product_id" : null,
  "namespace_id" : 2111918419,
  "parent_id" : 0,
  "ownership" : 0,
  "pbi" : 0,
  "protected_branches" : 1000,
  "protected_tags" : 1003,
  "push_rules" : 1000,
  "change_requests" : 0,
  "custom_ctrl_items" : 0,
  "reviews" : 0,
  "issues" : 0,
  "cr_evaluation" : 0,
  "e2e_settings" : 1000,
  "committer_settings" : 0,
  "webhook_settings" : 1000,
  "stream_event_settings" : 0,
  "pipeline_settings" : 0,
  "issue_templates" : 0,
  "cr_comment_templates" : 0,
  "merge_requests" : 1000,
  "mr_branch_policies" : 1000,
  "repository_settings" : 1000,
  "deploy_keys" : 1000,
  "watermark" : 1000,
  "created_at" : "2025-05-22 22:43:07 +0800",
  "update_at" : "2025-05-22 22:43:07 +0800"
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码:404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Group Not Found。Group Not Found"
}

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.v4.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v4.*;
import com.huaweicloud.sdk.codehub.v4.model.*;


public class ShowGroupSettingsInheritCfgSolution {

    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();
        ShowGroupSettingsInheritCfgRequest request = new ShowGroupSettingsInheritCfgRequest();
        request.withGroupId({group_id});
        try {
            ShowGroupSettingsInheritCfgResponse response = client.showGroupSettingsInheritCfg(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.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 = ShowGroupSettingsInheritCfgRequest()
        request.group_id = {group_id}
        response = client.show_group_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
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.ShowGroupSettingsInheritCfgRequest{}
	request.GroupId = int32({group_id})
	response, err := client.ShowGroupSettingsInheritCfg(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

Get Group Inheritance Settings

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档