Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Task Configuration Check Parameters
Updated on 2024-03-15 GMT+08:00

Task Configuration Check Parameters

Function

Task Configuration Check Parameters

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

task_id

Yes

String

Task ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 100000

Content-Type

Yes

String

Media type and encoding format.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

check_id

Yes

Integer

Check Tool ID

Minimum: 1

Maximum: 11

ruleset_id

Yes

String

Rule Set ID

Minimum: 1

Maximum: 64

language

Yes

String

Rule Set Language

Minimum: 1

Maximum: 128

status

Yes

String

off: disabled; on: enabled

Minimum: 1

Maximum: 3

task_check_settings

Yes

Array of TaskCheckSettingsItem objects

Checking Parameter Information

Table 4 TaskCheckSettingsItem

Parameter

Mandatory

Type

Description

cfg_key

Yes

String

Check the key value corresponding to the parameter.

Minimum: 1

Maximum: 50

status

Yes

String

Parameter Status

Minimum: 1

Maximum: 3

cfg_value

No

String

Checking Parameter Values

Minimum: 1

Maximum: 1000

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Task configuration check parameter: Check whether the language type of the parameter is csharp and the status is on.

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

{
  "check_id" : 11,
  "ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx",
  "language" : "csharp",
  "status" : "on",
  "task_check_settings" : [ {
    "cfg_key" : "csharpCompileTool",
    "status" : "on",
    "cfg_value" : "msbuild"
  } ]
}

Example Responses

Status code: 200

Request succeeded!

null

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "The network is busy. Please try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "The authentication information has expired."
}

SDK Sample Code

The SDK sample code is as follows.

Task configuration check parameter: Check whether the language type of the parameter is csharp and the status is 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
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();
        ConfigTaskParameterBody body = new ConfigTaskParameterBody();
        List<TaskCheckSettingsItem> listbodyTaskCheckSettings = new ArrayList<>();
        listbodyTaskCheckSettings.add(
            new TaskCheckSettingsItem()
                .withCfgKey("csharpCompileTool")
                .withStatus("on")
                .withCfgValue("msbuild")
        );
        body.withTaskCheckSettings(listbodyTaskCheckSettings);
        body.withStatus("on");
        body.withLanguage("csharp");
        body.withRulesetId("b113bxxxxxxxx5738bee86ecxxxxxxxx");
        body.withCheckId(11);
        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());
        }
    }
}

Task configuration check parameter: Check whether the language type of the parameter is csharp and the status is 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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()
        listTaskCheckSettingsbody = [
            TaskCheckSettingsItem(
                cfg_key="csharpCompileTool",
                status="on",
                cfg_value="msbuild"
            )
        ]
        request.body = ConfigTaskParameterBody(
            task_check_settings=listTaskCheckSettingsbody,
            status="on",
            language="csharp",
            ruleset_id="b113bxxxxxxxx5738bee86ecxxxxxxxx",
            check_id=11
        )
        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)

Task configuration check parameter: Check whether the language type of the parameter is csharp and the status is 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
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{}
	cfgValueTaskCheckSettings:= "msbuild"
	var listTaskCheckSettingsbody = []model.TaskCheckSettingsItem{
        {
            CfgKey: "csharpCompileTool",
            Status: "on",
            CfgValue: &cfgValueTaskCheckSettings,
        },
    }
	request.Body = &model.ConfigTaskParameterBody{
		TaskCheckSettings: listTaskCheckSettingsbody,
		Status: "on",
		Language: "csharp",
		RulesetId: "b113bxxxxxxxx5738bee86ecxxxxxxxx",
		CheckId: int32(11),
	}
	response, err := client.ListTaskParameter(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.