更新时间:2025-09-12 GMT+08:00
分享

创建扫描规则(待下线)

功能介绍

根据指定的规则名称、规则类型、风险等级、最小匹配次数、逻辑运算符、规则内容和规则描述创建自定义的敏感数据识别规则。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,用于标识具体的项目。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

category

String

规则类别,用于区分内置规则(BUILT_IN)和用户自定义规则(BUILT_SELF)。

id

String

规则ID,用于唯一标识该规则。

logic_operator

String

逻辑运算符,支持"AND"(与)、"OR"(或)、"REGEX"(正则表达式)。

min_match

Integer

最小匹配次数,表示规则匹配时需要满足的最小条件。

risk_level

Integer

风险等级,用于表示该规则识别出的敏感数据的风险程度。

rule_content

String

规则内容,具体取决于规则类型,如关键字、正则表达式或自然语言描述。

rule_desc

String

规则描述,对规则功能的简要说明。

rule_name

String

规则名称,用于标识和管理规则。

rule_type

String

规则类型,包括关键字(KEYWORD)、正则表达式(REGEX)或自然语言(NLP)。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

msg

String

返回消息,用于描述操作结果或状态信息。

status

String

返回状态,表示操作是否成功,如'200'表示成功,'400'表示无效请求。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,用于唯一标识具体的错误类型。

error_msg

String

错误信息,对错误的详细描述。

请求示例

创建规则名称为xxxx的自建规则,逻辑运算符选择AND,其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。

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

{
  "category" : "BUILT_SELF",
  "logic_operator" : "AND",
  "min_match" : 1,
  "risk_level" : 1,
  "rule_content" : "xxxx",
  "rule_desc" : "xxxx",
  "rule_name" : "xxxx",
  "rule_type" : "KEYWORD"
}

响应示例

状态码:200

请求成功,返回创建结果。

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

状态码:400

无效请求,参数格式或内容不符合要求。

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

SDK代码示例

SDK代码示例如下。

Java

创建规则名称为xxxx的自建规则,逻辑运算符选择AND,其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。

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


public class AddRuleSolution {

    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();
        AddRuleRequest request = new AddRuleRequest();
        RuleRequest body = new RuleRequest();
        body.withRuleType(RuleRequest.RuleTypeEnum.fromValue("KEYWORD"));
        body.withRuleName("xxxx");
        body.withRuleDesc("xxxx");
        body.withRuleContent("xxxx");
        body.withRiskLevel(1);
        body.withMinMatch(1);
        body.withLogicOperator("AND");
        body.withCategory(RuleRequest.CategoryEnum.fromValue("BUILT_SELF"));
        request.withBody(body);
        try {
            AddRuleResponse response = client.addRule(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

创建规则名称为xxxx的自建规则,逻辑运算符选择AND,其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。

 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 = AddRuleRequest()
        request.body = RuleRequest(
            rule_type="KEYWORD",
            rule_name="xxxx",
            rule_desc="xxxx",
            rule_content="xxxx",
            risk_level=1,
            min_match=1,
            logic_operator="AND",
            category="BUILT_SELF"
        )
        response = client.add_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

创建规则名称为xxxx的自建规则,逻辑运算符选择AND,其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。

 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
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.AddRuleRequest{}
	ruleDescRuleRequest:= "xxxx"
	request.Body = &model.RuleRequest{
		RuleType: model.GetRuleRequestRuleTypeEnum().KEYWORD,
		RuleName: "xxxx",
		RuleDesc: &ruleDescRuleRequest,
		RuleContent: "xxxx",
		RiskLevel: int32(1),
		MinMatch: int32(1),
		LogicOperator: "AND",
		Category: model.GetRuleRequestCategoryEnum().BUILT_SELF,
	}
	response, err := client.AddRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功,返回创建结果。

400

无效请求,参数格式或内容不符合要求。

错误码

请参见错误码

相关文档