Help Center/ Data Security Center/ API Reference/ API Description/ Sensitive Data Discovery/ Creating a Scan Rule Group (To Be Discontinued)
Updated on 2026-01-13 GMT+08:00

Creating a Scan Rule Group (To Be Discontinued)

Function

This API is used to create a sensitive data scanning rule group based on the specified rule group name, description, rule ID list, and category.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/sdg/server/scan/groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

category

No

String

Rule category, which is used to identify BUILT_IN (built-in rules) and BUILT_SELF (user-defined rules).

default_status

No

Boolean

Whether the default rule group is used.

group_desc

No

String

Rule group description, which briefly describes the rule group function.

group_name

No

String

Rule group name, which is used to identify and manage rule groups.

id

No

String

Rule group ID, which uniquely identifies a rule group.

rule_ids

No

Array of strings

List of rule IDs, which is used to specify all scan rules associated with the rule group.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

msg

String

Returned message, which is used to describe the operation result or status information.

status

String

Returned status, which indicates whether the operation is successful. For example, 200 indicates that the operation is successful, and 400 indicates that the request is invalid.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which uniquely identifies an error type.

error_msg

String

Error information, which describes the error details.

Example Requests

Create a self-built scanning rule group named xxxx.

POST /v1/{project_id}/sdg/server/scan/groups

{
  "category" : "BUILT_SELF",
  "group_desc" : "xxxx",
  "group_name" : "xxxx",
  "rule_ids" : [ "xxxxxxxxxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxx" ]
}

Example Responses

Status code: 200

Request succeeded. The creation result is returned.

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

Status code: 400

Invalid request. Incorrect parameter format or content.

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Create a self-built scanning rule group named xxxx.

 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
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.dsc.v1.region.DscRegion;
import com.huaweicloud.sdk.dsc.v1.*;
import com.huaweicloud.sdk.dsc.v1.model.*;

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

public class AddRuleGroupSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DscClient client = DscClient.newBuilder()
                .withCredential(auth)
                .withRegion(DscRegion.valueOf("<YOUR REGION>"))
                .build();
        AddRuleGroupRequest request = new AddRuleGroupRequest();
        RuleGroupRequest body = new RuleGroupRequest();
        List<String> listbodyRuleIds = new ArrayList<>();
        listbodyRuleIds.add("xxxxxxxxxxxxxxxxxxx");
        listbodyRuleIds.add("xxxxxxxxxxxxxxxxxxx");
        body.withRuleIds(listbodyRuleIds);
        body.withGroupName("xxxx");
        body.withGroupDesc("xxxx");
        body.withCategory(RuleGroupRequest.CategoryEnum.fromValue("BUILT_SELF"));
        request.withBody(body);
        try {
            AddRuleGroupResponse response = client.addRuleGroup(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

Create a self-built scanning rule group named xxxx.

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdsc.v1 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DscClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DscRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddRuleGroupRequest()
        listRuleIdsbody = [
            "xxxxxxxxxxxxxxxxxxx",
            "xxxxxxxxxxxxxxxxxxx"
        ]
        request.body = RuleGroupRequest(
            rule_ids=listRuleIdsbody,
            group_name="xxxx",
            group_desc="xxxx",
            category="BUILT_SELF"
        )
        response = client.add_rule_group(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

Create a self-built scanning rule group named xxxx.

 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"
    dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dsc.NewDscClient(
        dsc.DscClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddRuleGroupRequest{}
	var listRuleIdsbody = []string{
        "xxxxxxxxxxxxxxxxxxx",
	    "xxxxxxxxxxxxxxxxxxx",
    }
	groupNameRuleGroupRequest:= "xxxx"
	groupDescRuleGroupRequest:= "xxxx"
	categoryRuleGroupRequest:= model.GetRuleGroupRequestCategoryEnum().BUILT_SELF
	request.Body = &model.RuleGroupRequest{
		RuleIds: &listRuleIdsbody,
		GroupName: &groupNameRuleGroupRequest,
		GroupDesc: &groupDescRuleGroupRequest,
		Category: &categoryRuleGroupRequest,
	}
	response, err := client.AddRuleGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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. The creation result is returned.

400

Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.