Updated on 2026-01-13 GMT+08:00

Modifying a Scan Rule (To Be Discontinued)

Function

This API is used to modify a custom sensitive data identification rule. The rule name, type, risk level, minimum matching times, logical operator, rule content, and description can be updated.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/sdg/server/scan/rules

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

Yes

String

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

id

Yes

String

Rule ID, which uniquely identifies a rule.

logic_operator

Yes

String

Logical operator, which can be AND, OR, or REGEX (regular expression).

min_match

Yes

Integer

Minimum matching times, that is, the minimum condition that must be met when a rule is matched.

risk_level

Yes

Integer

Risk level, which indicates the risk level of the sensitive data identified by the rule.

rule_content

Yes

String

Rule content, which depends on the rule type, such as keyword, regular expression, or natural language description.

rule_desc

No

String

Rule description, which briefly describes the rule function.

rule_name

Yes

String

Rule name, which is used to identify and manage rules.

rule_type

Yes

String

Rule type, which can be KEYWORD (keyword), REGEX (regular expression), or NLP (natural language).

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

Modify a user-defined rule named xxxx, of which the logical operator is set to OR, minimum match value to 1, risk level to 1, rule content to xxxx, rule description to xxxx, and rule type to xxxx.

PUT /v1/{project_id}/sdg/server/scan/rules

{
  "category" : "BUILT_SELF",
  "id" : "xxxxxxxxxxxxxxxxxxx",
  "logic_operator" : "OR",
  "min_match" : 1,
  "risk_level" : 1,
  "rule_content" : "xxxx",
  "rule_desc" : "xxxx",
  "rule_name" : "xxxx",
  "rule_type" : "xxxx"
}

Example Responses

Status code: 200

Request succeeded. The change 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

Modify a user-defined rule named xxxx, of which the logical operator is set to OR, minimum match value to 1, risk level to 1, rule content to xxxx, rule description to xxxx, and rule type to 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.*;


public class ChangeRuleSolution {

    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();
        ChangeRuleRequest request = new ChangeRuleRequest();
        RuleChangeRequest body = new RuleChangeRequest();
        body.withRuleType(RuleChangeRequest.RuleTypeEnum.fromValue("xxxx"));
        body.withRuleName("xxxx");
        body.withRuleDesc("xxxx");
        body.withRuleContent("xxxx");
        body.withRiskLevel(1);
        body.withMinMatch(1);
        body.withLogicOperator("OR");
        body.withId("xxxxxxxxxxxxxxxxxxx");
        body.withCategory(RuleChangeRequest.CategoryEnum.fromValue("BUILT_SELF"));
        request.withBody(body);
        try {
            ChangeRuleResponse response = client.changeRule(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

Modify a user-defined rule named xxxx, of which the logical operator is set to OR, minimum match value to 1, risk level to 1, rule content to xxxx, rule description to xxxx, and rule type to 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
# 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 = ChangeRuleRequest()
        request.body = RuleChangeRequest(
            rule_type="xxxx",
            rule_name="xxxx",
            rule_desc="xxxx",
            rule_content="xxxx",
            risk_level=1,
            min_match=1,
            logic_operator="OR",
            id="xxxxxxxxxxxxxxxxxxx",
            category="BUILT_SELF"
        )
        response = client.change_rule(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

Modify a user-defined rule named xxxx, of which the logical operator is set to OR, minimum match value to 1, risk level to 1, rule content to xxxx, rule description to xxxx, and rule type to 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
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.ChangeRuleRequest{}
	ruleDescRuleChangeRequest:= "xxxx"
	request.Body = &model.RuleChangeRequest{
		RuleType: model.GetRuleChangeRequestRuleTypeEnum().XXXX,
		RuleName: "xxxx",
		RuleDesc: &ruleDescRuleChangeRequest,
		RuleContent: "xxxx",
		RiskLevel: int32(1),
		MinMatch: int32(1),
		LogicOperator: "OR",
		Id: "xxxxxxxxxxxxxxxxxxx",
		Category: model.GetRuleChangeRequestCategoryEnum().BUILT_SELF,
	}
	response, err := client.ChangeRule(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 change result is returned.

400

Invalid request. Incorrect parameter format or content.

Error Codes

See Error Codes.