文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ ThirdParty/ 获取项目下E2E设置信息 - ShowProjectE2eSetting
更新时间:2026-01-27 GMT+08:00

获取项目下E2E设置信息 - ShowProjectE2eSetting

功能介绍

获取项目下E2E设置信息

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsrepo::getProjectSetting

Read

-

codeartsrepo:ProjectId

-

-

URI

GET /v4/projects/{project_id}/e2e-setting

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

e2e_policies

E2ePolicyDto object

参数解释:

E2E公共设置信息。

req

ReqSettingDto object

参数解释:

可集成系统CodeArts Req设置信息。

link

LinkSettingDto object

参数解释:

可集成系统Link服务设置信息。

表4 E2ePolicyDto

参数

参数类型

描述

auto_extract

Boolean

参数解释:

是否开启单号自动提取。

取值范围:

true:开启单号自动提取,false:未开启单号自动提取。

prefix_symbol

String

参数解释:

自动提取时的单号前缀合集,英文逗号分隔。

取值范围:

单个前缀长度最多200个字符,最多允许配置10个前缀。

separator

String

参数解释:

自动提取时的分隔符。

suffix_symbol

String

参数解释:

自动提取时的单号后缀。

表5 ReqSettingDto

参数

参数类型

描述

active

Boolean

参数解释:

是否开启集成CodeArts Req

取值范围:

true:开启集成CodeArts Req,false:未开启集成CodeArts Req。

branches

String

参数解释:

应用排除状态和可关联类别限制的分支列表,该分支指代合并请求的目标分支,可支持多个分支用英文逗号拼接或者正则表达式,在项目层级和代码组层级只支持配置正则表达式。

branches_type

String

参数解释:

分支的类型,文本或者正则表达式。

取值范围:

plain代表文本,regex代表正则表达式。

project_type

String

参数解释:

关联的CodeArts Req项目类型。

取值范围:

scrum代表scrum类型项目,ipd代表IPD类型项目, xboard为看板类型项目。

categories

String

参数解释:

可关联类型列表,逗号分隔。

category_codes

String

参数解释:

可关联类型编码列表,逗号分隔。

exclude_statuses

String

参数解释:

排除状态列表,逗号分隔。

exclude_status_codes

String

参数解释:

排除状态编码列表,逗号分隔。

表6 LinkSettingDto

参数

参数类型

描述

active

Boolean

参数解释:

是否开启集成Link服务

取值范围:

true:开启集成Link服务,false:未开启集成Link服务。

url

String

参数解释:

Link服务的对接地址。

app_auth_type

String

参数解释:

Link服务的对接鉴权类型,ak_sk代表使用ak和sk来鉴权。

app_ak

String

参数解释:

Link服务的对接鉴权ak。

app_sk

String

参数解释:

Link服务的对接鉴权sk,作为返回值时若已配置则返回掩码,掩码格式为************。

categories

String

参数解释:

可关联类型列表,逗号分隔。

exclude_statuses

String

参数解释:

排除状态列表,逗号分隔。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/e2e-setting

响应示例

状态码:200

OK

{
  "e2e_policies" : {
    "auto_extract" : true,
    "prefix_symbol" : "TicketNo",
    "separator" : ";",
    "suffix_symbol" : "\\\\n"
  },
  "req" : {
    "active" : true,
    "branches" : "dev",
    "branches_type" : "plain",
    "categories" : "Epic,Story",
    "category_codes" : "5,7",
    "exclude_statuses" : "新建,已解决",
    "exclude_status_codes" : "1,3",
    "project_type" : "scrum"
  },
  "link" : {
    "active" : true,
    "url" : "https://demo.com",
    "app_auth_type" : "ak_sk",
    "app_ak" : "testak",
    "app_sk" : "************",
    "categories" : "IR",
    "exclude_statuses" : "新建"
  }
}

状态码: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.codeartsrepo.v4.region.CodeArtsRepoRegion;
import com.huaweicloud.sdk.codeartsrepo.v4.*;
import com.huaweicloud.sdk.codeartsrepo.v4.model.*;


public class ShowProjectE2eSettingSolution {

    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);

        CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsRepoRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowProjectE2eSettingRequest request = new ShowProjectE2eSettingRequest();
        request.withProjectId("{project_id}");
        try {
            ShowProjectE2eSettingResponse response = client.showProjectE2eSetting(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 huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsrepo.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 = CodeArtsRepoClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsRepoRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowProjectE2eSettingRequest()
        request.project_id = "{project_id}"
        response = client.show_project_e2e_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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/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 := codeartsrepo.NewCodeArtsRepoClient(
        codeartsrepo.CodeArtsRepoClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowProjectE2eSettingRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowProjectE2eSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码