更新时间:2025-07-15 GMT+08:00
分享

获取检视意见设置

功能介绍

获取检视意见设置

调试

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

URI

GET /v4/repositories/{repository_id}/review-setting

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

with_default_review_categories

Boolean

参数解释:

额外返回可勾选检视意见分类和系统预置检视意见分类。

取值范围:

  • true, 返回可勾选检视意见分类和系统预置检视意见分类。

  • false, 不返回可勾选检视意见分类和系统预置检视意见分类。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

categories_and_modules_enabled

Boolean

参数解释:

是否启用启用检视意见分类与模块。

secondary_category_enabled

Boolean

参数解释:

是否启用系统预置检视意见分类。

primary_categories

Array of categoryDto objects

参数解释:

检视意见分类(已勾选)。

review_default_categories

Array of strings

参数解释:

检视意见分类的key(已勾选)。

review_customized_categories

Array of strings

参数解释:

自定义分类。

review_modules

Array of strings

参数解释:

检视意见模块。

repository_id

Integer

参数解释:

仓库id。

取值范围:

1-2147483647

note_required_attributes

Array of RequiredAttributeDto objects

参数解释:

检视意见必填项。

codehub_default_categories

Array of categoryDto objects

参数解释:

检视意见分类(所有可勾选的,需传参with_default_review_categories: true才返回)。

hicode_default_categories

Array of categoryDto objects

参数解释:

系统预置检视意见分类(需传参with_default_review_categories: true才返回)。

表5 RequiredAttributeDto

参数

参数类型

描述

name

String

参数解释:

必填字段名称。

描述:Body

严重程度:Severity

指派给:AssigneeId

意见分类:ReviewCategories

意见模块:ReviewModules

枚举值:

  • Body

  • Severity

  • AssigneeId

  • ReviewCategories

  • ReviewModules

is_required

Boolean

参数解释:

是否必填。

表6 categoryDto

参数

参数类型

描述

key

String

参数解释:

检视意见分类key。

name_zh

String

参数解释:

检视意见分类中文名。

name_en

String

参数解释:

检视意见分类英文名。

sub_categories

Array of categoryDto objects

参数解释:

子检视意见分类。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

响应示例

状态码:200

ok

{
  "categories_and_modules_enabled" : true,
  "secondary_category_enabled" : false,
  "primary_categories" : [ {
    "key" : "realize",
    "name_zh" : "算法实现",
    "name_en" : "Algorithm"
  }, {
    "key" : "design",
    "name_zh" : "代码设计",
    "name_en" : "Code design"
  } ],
  "review_default_categories" : [ "realize", "design" ],
  "review_customized_categories" : [ "分类" ],
  "review_modules" : [ "模块" ],
  "note_required_attributes" : [ {
    "name" : "AssigneeId",
    "is_required" : true
  }, {
    "name" : "Body",
    "is_required" : true
  }, {
    "name" : "ReviewCategories",
    "is_required" : true
  }, {
    "name" : "ReviewModules",
    "is_required" : true
  }, {
    "name" : "Severity",
    "is_required" : true
  } ]
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "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 ShowReviewSettingSolution {

    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();
        ShowReviewSettingRequest request = new ShowReviewSettingRequest();
        request.withRepositoryId({repository_id});
        try {
            ShowReviewSettingResponse response = client.showReviewSetting(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 = ShowReviewSettingRequest()
        request.repository_id = {repository_id}
        response = client.show_review_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"
    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.ShowReviewSettingRequest{}
	request.RepositoryId = int32({repository_id})
	response, err := client.ShowReviewSetting(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

ok

401

Unauthorized

错误码

请参见错误码

相关文档