Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Modifying the Rule Set in a Task
Updated on 2026-02-03 GMT+08:00

Modifying the Rule Set in a Task

Function

This API is used to modify the rule set configuration of a code check task. You can set the rule set ID, rule set language, and rule set status.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v2/tasks/{task_id}/ruleset

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of UpdateTaskRulesetItem objects

Definition

Rule set information.

Constraints

N/A

Table 4 UpdateTaskRulesetItem

Parameter

Mandatory

Type

Description

language

Yes

String

Definition

Check language. For details about the supported languages, see the feature updates.

Constraints

N/A

Range

N/A

Default Value

N/A

rule_set_id

Yes

String

Definition:

Rule set ID.

Constraints:

1 to 32 characters.

Value range:

N/A

Default value:

N/A

if_use

Yes

String

Definition

Whether to enable the rule set.

Constraints

N/A

Range

  • 0: Do not enable

  • 1: Enable

Default Value

N/A

status

Yes

String

Definition

New or old data.

Constraints

N/A

Range

1

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded!

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Modify the rule set of a task: Set the language to cpp and the rule status to 1. The rule setting ID is displayed based on the actual situation.

PUT https://{endpoint}/v2/tasks/{task_id}/ruleset

[ {
  "language" : "cpp",
  "rule_set_id" : "7be4cfxxxxxxxxfd8d07077cxxxxxxxx",
  "if_use" : "1",
  "status" : "1"
} ]

Example Responses

Status code: 200

Request succeeded!

null

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

SDK Sample Code

The SDK sample code is as follows.

Modify the rule set of a task: Set the language to cpp and the rule status to 1. The rule setting ID is displayed based on the actual situation.

 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
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 UpdateTaskRulesetSolution {

    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();
        UpdateTaskRulesetRequest request = new UpdateTaskRulesetRequest();
        request.withTaskId("{task_id}");
        List<UpdateTaskRulesetItem> listbodyUpdateTaskRuleset = new ArrayList<>();
        listbodyUpdateTaskRuleset.add(
            new UpdateTaskRulesetItem()
                .withLanguage("cpp")
                .withRuleSetId("7be4cfxxxxxxxxfd8d07077cxxxxxxxx")
                .withIfUse("1")
                .withStatus("1")
        );
        request.withBody(listbodyUpdateTaskRuleset);
        try {
            UpdateTaskRulesetResponse response = client.updateTaskRuleset(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());
        }
    }
}

Modify the rule set of a task: Set the language to cpp and the rule status to 1. The rule setting ID is displayed based on the actual situation.

 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
# 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 = UpdateTaskRulesetRequest()
        request.task_id = "{task_id}"
        listUpdateTaskRulesetbody = [
            UpdateTaskRulesetItem(
                language="cpp",
                rule_set_id="7be4cfxxxxxxxxfd8d07077cxxxxxxxx",
                if_use="1",
                status="1"
            )
        ]
        request.body = listUpdateTaskRulesetbody
        response = client.update_task_ruleset(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modify the rule set of a task: Set the language to cpp and the rule status to 1. The rule setting ID is displayed based on the actual situation.

 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
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.UpdateTaskRulesetRequest{}
	request.TaskId = "{task_id}"
	var listUpdateTaskRulesetbody = []model.UpdateTaskRulesetItem{
        {
            Language: "cpp",
            RuleSetId: "7be4cfxxxxxxxxfd8d07077cxxxxxxxx",
            IfUse: "1",
            Status: "1",
        },
    }
	request.Body = &listUpdateTaskRulesetbody
	response, err := client.UpdateTaskRuleset(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.