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

配置任务检查参数

功能介绍

基于规则集配置对应的任务配置检查参数

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/tasks/{task_id}/config-parameters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

X-Language

String

参数解释:

语言,决定响应以哪种语言返回。

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

check_id

Integer

参数解释:

参数已废弃,默认填写0即可。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

ruleset_id

String

参数解释:

规则集ID,通过查询规则集列表接口可获取到规则集ID。

约束限制:

不涉及。

取值范围:

32位规则集ID。

默认取值:

不涉及。

language

String

参数解释:

规则集对应语言,通过查询规则集列表接口可获取到规则集ID对应的语言。

约束限制:

不涉及。

取值范围:

与ruleset_id规则集的语言对应。

默认取值:

不涉及。

status

String

参数解释:

当前规则集对应的编译配置总开关。

约束限制:

不涉及。

取值范围:

  • off:关闭。

  • on:打开。

默认取值:

不涉及。

task_check_settings

Array of TaskCheckSettingsItem objects

参数解释:

数组类型,当前规则集对应编译配置具体详情,可基于web页面查看当前规则集所涉及的编译配置,多个参数配置多条即可。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 TaskCheckSettingsItem

参数

是否必选

参数类型

描述

cfg_key

String

参数解释:

规则集对应的编译配置条件键。

约束限制:

不涉及。

取值范围:

  • compileTool:编译工具。

  • buildToolVersion:编译工具版本。

  • compileScriptCmd:编译命令。

默认取值:

不涉及。

status

String

参数解释:

当前检查参数key对应的开启状态,填写"on"即可。

约束限制:

不涉及。

取值范围:

"on"。

默认取值:

不涉及

cfg_value

String

参数解释:

规则集对应的编译配置值。

约束限制:

不涉及。

取值范围:

可选值可以在web页面-任务设置-规则集-编译配置直接获取。

默认取值:

不涉及。

响应参数

状态码:200

Request succeeded!

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

任务配置编译参数:语言类型为java,状态为on

POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-parameters

{
  "check_id" : 0,
  "ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx",
  "language" : "java",
  "status" : "on",
  "task_check_settings" : [ {
    "cfg_value" : "maven",
    "cfg_key" : "compileTool",
    "status" : "on"
  }, {
    "cfg_value" : "maven3.8.5-jdk17",
    "cfg_key" : "buildToolVersion",
    "status" : "on"
  }, {
    "cfg_value" : "mvn clean package -Dmaven.test.skip=true -U -e -X -B",
    "cfg_key" : "compileScriptCmd",
    "status" : "on"
  } ]
}

响应示例

状态码:200

Request succeeded!

null

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

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

SDK代码示例

SDK代码示例如下。

任务配置编译参数:语言类型为java,状态为on

 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
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.codecheck.v2.region.CodeCheckRegion;
import com.huaweicloud.sdk.codecheck.v2.*;
import com.huaweicloud.sdk.codecheck.v2.model.*;

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

public class ListTaskParameterSolution {

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

        CodeCheckClient client = CodeCheckClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeCheckRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTaskParameterRequest request = new ListTaskParameterRequest();
        request.withProjectId("{project_id}");
        request.withTaskId("{task_id}");
        ConfigTaskParameterBody body = new ConfigTaskParameterBody();
        List<TaskCheckSettingsItem> listbodyTaskCheckSettings = new ArrayList<>();
        listbodyTaskCheckSettings.add(
            new TaskCheckSettingsItem()
                .withCfgKey("compileTool")
                .withStatus("on")
                .withCfgValue("maven")
        );
        listbodyTaskCheckSettings.add(
            new TaskCheckSettingsItem()
                .withCfgKey("buildToolVersion")
                .withStatus("on")
                .withCfgValue("maven3.8.5-jdk17")
        );
        listbodyTaskCheckSettings.add(
            new TaskCheckSettingsItem()
                .withCfgKey("compileScriptCmd")
                .withStatus("on")
                .withCfgValue("mvn clean package -Dmaven.test.skip=true -U -e -X -B")
        );
        body.withTaskCheckSettings(listbodyTaskCheckSettings);
        body.withStatus("on");
        body.withLanguage("java");
        body.withRulesetId("b113bxxxxxxxx5738bee86ecxxxxxxxx");
        body.withCheckId(0);
        request.withBody(body);
        try {
            ListTaskParameterResponse response = client.listTaskParameter(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());
        }
    }
}

任务配置编译参数:语言类型为java,状态为on

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodecheck.v2.region.codecheck_region import CodeCheckRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodecheck.v2 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 = CodeCheckClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeCheckRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTaskParameterRequest()
        request.project_id = "{project_id}"
        request.task_id = "{task_id}"
        listTaskCheckSettingsbody = [
            TaskCheckSettingsItem(
                cfg_key="compileTool",
                status="on",
                cfg_value="maven"
            ),
            TaskCheckSettingsItem(
                cfg_key="buildToolVersion",
                status="on",
                cfg_value="maven3.8.5-jdk17"
            ),
            TaskCheckSettingsItem(
                cfg_key="compileScriptCmd",
                status="on",
                cfg_value="mvn clean package -Dmaven.test.skip=true -U -e -X -B"
            )
        ]
        request.body = ConfigTaskParameterBody(
            task_check_settings=listTaskCheckSettingsbody,
            status="on",
            language="java",
            ruleset_id="b113bxxxxxxxx5738bee86ecxxxxxxxx",
            check_id=0
        )
        response = client.list_task_parameter(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

任务配置编译参数:语言类型为java,状态为on

 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
package main

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

    request := &model.ListTaskParameterRequest{}
	request.ProjectId = "{project_id}"
	request.TaskId = "{task_id}"
	cfgValueTaskCheckSettings:= "maven"
	cfgValueTaskCheckSettings1:= "maven3.8.5-jdk17"
	cfgValueTaskCheckSettings2:= "mvn clean package -Dmaven.test.skip=true -U -e -X -B"
	var listTaskCheckSettingsbody = []model.TaskCheckSettingsItem{
        {
            CfgKey: "compileTool",
            Status: "on",
            CfgValue: &cfgValueTaskCheckSettings,
        },
        {
            CfgKey: "buildToolVersion",
            Status: "on",
            CfgValue: &cfgValueTaskCheckSettings1,
        },
        {
            CfgKey: "compileScriptCmd",
            Status: "on",
            CfgValue: &cfgValueTaskCheckSettings2,
        },
    }
	request.Body = &model.ConfigTaskParameterBody{
		TaskCheckSettings: listTaskCheckSettingsbody,
		Status: "on",
		Language: "java",
		RulesetId: "b113bxxxxxxxx5738bee86ecxxxxxxxx",
		CheckId: int32(0),
	}
	response, err := client.ListTaskParameter(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档