Help Center/ CodeArts Check/ API Reference/ APIs/ Rule Management/ Creating a User-Defined Rule Set
Updated on 2024-03-15 GMT+08:00

Creating a User-Defined Rule Set

Function

Rules can be flexibly combined as required.

Calling Method

For details, see Calling APIs.

URI

POST /v2/ruleset

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Setting the Media Type and Encoding Format

X-Auth-Token

Yes

String

User token.

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Minimum: 1

Maximum: 50

template_name

Yes

String

New Rule Set Name

Minimum: 1

Maximum: 500

language

Yes

String

Rule Set Language

Minimum: 1

Maximum: 128

is_default

Yes

String

If there is a rule set based on, the value is 1. If there is no rule set based on, the value is 0.

Minimum: 1

Maximum: 1

rule_ids

Yes

String

ID of the newly enabled rule.

Minimum: 1

Maximum: 4000

uncheck_ids

No

String

ID of the new closure rule.

Minimum: 1

Maximum: 4000

template_id

No

String

Rule Set ID

Minimum: 1

Maximum: 50

custom_attributes

No

Array of CustomAttributes objects

Users can customize rule parameters and modify rule thresholds.

Table 3 CustomAttributes

Parameter

Mandatory

Type

Description

attribute

No

String

Indicates the configuration item attribute. severity indicates the problem severity.

rules

No

Array of CustomAttributesRule objects

Rule Details

Table 4 CustomAttributesRule

Parameter

Mandatory

Type

Description

rule_id

No

String

Rule ID.

value

No

String

Attribute problem level. The options are as follows: 0: critical; 1: major; 2: minor; 3: warning.

rule_config_list

No

Array of RuleConfig objects

Rule Threshold Details

Table 5 RuleConfig

Parameter

Mandatory

Type

Description

id

No

Integer

Rule Configuration ID

rule_id

No

Integer

Rule ID.

default_value

No

String

Default Value

option_value

No

String

Before acceleration

option_key

No

String

Key of the current rule configuration item.

option_name

No

String

Name of the current rule configuration item

template_id

No

String

Rule Set ID

description

No

String

Description

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

template_id

String

Rule Set ID

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Create a user-defined rule set. The project ID and template ID corresponding to the rule set are displayed based on the site requirements. The template name is test_cpp, and the language is cpp.

POST https://{endpoint}/v2/ruleset

{
  "project_id" : "24b97exxxxxxxxfb912625b14cxxxxxx",
  "template_id" : "da303dxxxxxxxxaca60dbcc2e2xxxxxx",
  "template_name" : "test_cpp",
  "language" : "cpp",
  "is_default" : "1",
  "rule_ids" : "8139,8138",
  "uncheck_ids" : "1101,1102"
}

Example Responses

Status code: 201

Request succeeded!

{
  "template_id" : "c53417a4804f45eba9c11991131c9e79"
}

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.

Create a user-defined rule set. The project ID and template ID corresponding to the rule set are displayed based on the site requirements. The template name is test_cpp, and the language is cpp.

 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
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.*;


public class CreateRulesetSolution {

    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();
        CreateRulesetRequest request = new CreateRulesetRequest();
        Ruleset body = new Ruleset();
        body.withTemplateId("da303dxxxxxxxxaca60dbcc2e2xxxxxx");
        body.withUncheckIds("1101,1102");
        body.withRuleIds("8139,8138");
        body.withIsDefault("1");
        body.withLanguage("cpp");
        body.withTemplateName("test_cpp");
        body.withProjectId("24b97exxxxxxxxfb912625b14cxxxxxx");
        request.withBody(body);
        try {
            CreateRulesetResponse response = client.createRuleset(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());
        }
    }
}

Create a user-defined rule set. The project ID and template ID corresponding to the rule set are displayed based on the site requirements. The template name is test_cpp, and the language is cpp.

 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
# 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 = CreateRulesetRequest()
        request.body = Ruleset(
            template_id="da303dxxxxxxxxaca60dbcc2e2xxxxxx",
            uncheck_ids="1101,1102",
            rule_ids="8139,8138",
            is_default="1",
            language="cpp",
            template_name="test_cpp",
            project_id="24b97exxxxxxxxfb912625b14cxxxxxx"
        )
        response = client.create_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)

Create a user-defined rule set. The project ID and template ID corresponding to the rule set are displayed based on the site requirements. The template name is test_cpp, and the language is cpp.

 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 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.CreateRulesetRequest{}
	templateIdRuleset:= "da303dxxxxxxxxaca60dbcc2e2xxxxxx"
	uncheckIdsRuleset:= "1101,1102"
	request.Body = &model.Ruleset{
		TemplateId: &templateIdRuleset,
		UncheckIds: &uncheckIdsRuleset,
		RuleIds: "8139,8138",
		IsDefault: "1",
		Language: "cpp",
		TemplateName: "test_cpp",
		ProjectId: "24b97exxxxxxxxfb912625b14cxxxxxx",
	}
	response, err := client.CreateRuleset(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

201

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.