文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据安全API/ 识别规则接口/ 创建识别规则

更新时间：2024-11-22 GMT+08:00

在线调试

CLI示例

查看PDF

创建识别规则

功能介绍

创建识别规则。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/security/data-classification/rule

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
workspace	是	String	工作空间ID，获取方法请参见实例ID和工作空间ID。
X-Auth-Token	是	String	IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）使用Token认证时必选。

表3 请求Body参数
参数	是否必选	参数类型	描述
rule_type	是	String	规则类型, CUSTOM, BUILTIN
secrecy_level_id	是	String	密级ID。
name	是	String	规则名称;rule_type为CUSTOM时用户可自定义名称,rule_type为BUILTIN时输入的名称需要和内置模板中的名称一致。
method	否	String	规则方式, REGULAR, NONE, DEFAULT, COMBINE
content_expression	否	String	内容表达式;只有当rule_type为CUSTOM且method为REGULAR时才必需要此参数。
column_expression	否	String	列表达式;只有当rule_type为CUSTOM且method为REGULAR时才必需要此参数。
commit_expression	否	String	备注表达式;只有当rule_type为CUSTOM且method为REGULAR时才必需要此参数。
combine_expression	否	String	条件表达式
builtin_rule_id	否	String	内置规则id,只有当rule_type为BUILTIN时才需要此参数。
description	否	String	规则描述。
category_id	否	String	分类ID。
enable	否	Boolean	使能状态。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
uuid	String	规则ID。
rule_type	String	规则类型, CUSTOM, BUILTIN
secrecy_level	String	密级名称。
secrecy_level_num	Long	密级层级。
name	String	规则名称。
guid	String	guid。
enable	Boolean	规则是否开启。
method	String	规则方式, REGULAR, NONE, DEFAULT
content_expression	String	内容表达式。
column_expression	String	列表达式。
commit_expression	String	备注表达式。
project_id	String	项目ID。
description	String	规则描述。
created_by	String	策略创建人。
created_at	Long	策略创建时间。
updated_by	String	策略更新人。
updated_at	Long	策略更新时间。
builtin_rule_id	String	内置规则ID。
category_id	String	分类ID。
instance_id	String	实例ID。
match_type	String	匹配类型。

状态码： 400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

/v1/0833a5737480d53b2f25c010dc1a7b88/security/data-classification/rule

{
  "rule_type" : "CUSTOM",
  "secrecy_level_id" : "8a9480ad7e992660017e9a381244000d",
  "category_id" : "0cce38e7c28547828905ae9e4f10a4bf",
  "name" : "Special_Administrative_Region_test",
  "method" : "REGULAR",
  "description" : "testModifyDes",
  "content_expression" : "testExpression"
}

/v1/0833a5737480d53b2f25c010dc1a7b88/security/data-classification/rule

{
  "builtin_rule_id" : "a5adcca681f011e9a870765a9db3b202",
  "rule_type" : "BUILTIN",
  "secrecy_level_id" : "8a9480ad7e992660017e9a381244000d",
  "category_id" : "0cce38e7c28547828905ae9e4f10a4bf",
  "name" : "Bank_Account",
  "description" : "testCreateBuiltInRule"
}

响应示例

状态码： 200

{
  "builtin_rule_id" : null,
  "category_id" : "0cce38e7c28547828905ae9e4f10a4bf",
  "column_expression" : null,
  "commit_expression" : null,
  "content_expression" : ".*",
  "created_at" : 1698633124002,
  "created_by" : "chenxiaoyu",
  "description" : "",
  "enable" : true,
  "guid" : null,
  "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc",
  "match_type" : null,
  "method" : "REGULAR",
  "name" : "matchRules",
  "project_id" : "0833a5737480d53b2f25c010dc1a7b88",
  "rule_type" : "CUSTOM",
  "secrecy_level" : "asd",
  "secrecy_level_num" : 1,
  "updated_at" : 1698633124002,
  "updated_by" : "chenxiaoyu",
  "uuid" : "8a94800e8b753a35018b7e6be6950023"
}

SDK代码示例

SDK代码示例如下。

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


public class CreateSecurityDataClassificationRuleSolution {

    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);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateSecurityDataClassificationRuleRequest request = new CreateSecurityDataClassificationRuleRequest();
        DataClassificationRuleOperateDTO body = new DataClassificationRuleOperateDTO();
        body.withCategoryId("0cce38e7c28547828905ae9e4f10a4bf");
        body.withDescription("testModifyDes");
        body.withContentExpression("testExpression");
        body.withMethod(DataClassificationRuleOperateDTO.MethodEnum.fromValue("REGULAR"));
        body.withName("Special_Administrative_Region_test");
        body.withSecrecyLevelId("8a9480ad7e992660017e9a381244000d");
        body.withRuleType(DataClassificationRuleOperateDTO.RuleTypeEnum.fromValue("CUSTOM"));
        request.withBody(body);
        try {
            CreateSecurityDataClassificationRuleResponse response = client.createSecurityDataClassificationRule(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());
        }
    }
}

            

          

        
       

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


public class CreateSecurityDataClassificationRuleSolution {

    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);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateSecurityDataClassificationRuleRequest request = new CreateSecurityDataClassificationRuleRequest();
        DataClassificationRuleOperateDTO body = new DataClassificationRuleOperateDTO();
        body.withCategoryId("0cce38e7c28547828905ae9e4f10a4bf");
        body.withDescription("testCreateBuiltInRule");
        body.withBuiltinRuleId("a5adcca681f011e9a870765a9db3b202");
        body.withName("Bank_Account");
        body.withSecrecyLevelId("8a9480ad7e992660017e9a381244000d");
        body.withRuleType(DataClassificationRuleOperateDTO.RuleTypeEnum.fromValue("BUILTIN"));
        request.withBody(body);
        try {
            CreateSecurityDataClassificationRuleResponse response = client.createSecurityDataClassificationRule(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());
        }
    }
}

            

          

        
       

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateSecurityDataClassificationRuleRequest()
        request.body = DataClassificationRuleOperateDTO(
            category_id="0cce38e7c28547828905ae9e4f10a4bf",
            description="testModifyDes",
            content_expression="testExpression",
            method="REGULAR",
            name="Special_Administrative_Region_test",
            secrecy_level_id="8a9480ad7e992660017e9a381244000d",
            rule_type="CUSTOM"
        )
        response = client.create_security_data_classification_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)

            

          

        
       

        
         
           
           
             # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateSecurityDataClassificationRuleRequest()
        request.body = DataClassificationRuleOperateDTO(
            category_id="0cce38e7c28547828905ae9e4f10a4bf",
            description="testCreateBuiltInRule",
            builtin_rule_id="a5adcca681f011e9a870765a9db3b202",
            name="Bank_Account",
            secrecy_level_id="8a9480ad7e992660017e9a381244000d",
            rule_type="BUILTIN"
        )
        response = client.create_security_data_classification_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)

            

          

        
       

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateSecurityDataClassificationRuleRequest{}
	categoryIdDataClassificationRuleOperateDto:= "0cce38e7c28547828905ae9e4f10a4bf"
	descriptionDataClassificationRuleOperateDto:= "testModifyDes"
	contentExpressionDataClassificationRuleOperateDto:= "testExpression"
	methodDataClassificationRuleOperateDto:= model.GetDataClassificationRuleOperateDtoMethodEnum().REGULAR
	nameDataClassificationRuleOperateDto:= "Special_Administrative_Region_test"
	secrecyLevelIdDataClassificationRuleOperateDto:= "8a9480ad7e992660017e9a381244000d"
	ruleTypeDataClassificationRuleOperateDto:= model.GetDataClassificationRuleOperateDtoRuleTypeEnum().CUSTOM
	request.Body = &model.DataClassificationRuleOperateDto{
		CategoryId: &categoryIdDataClassificationRuleOperateDto,
		Description: &descriptionDataClassificationRuleOperateDto,
		ContentExpression: &contentExpressionDataClassificationRuleOperateDto,
		Method: &methodDataClassificationRuleOperateDto,
		Name: &nameDataClassificationRuleOperateDto,
		SecrecyLevelId: &secrecyLevelIdDataClassificationRuleOperateDto,
		RuleType: &ruleTypeDataClassificationRuleOperateDto,
	}
	response, err := client.CreateSecurityDataClassificationRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateSecurityDataClassificationRuleRequest{}
	categoryIdDataClassificationRuleOperateDto:= "0cce38e7c28547828905ae9e4f10a4bf"
	descriptionDataClassificationRuleOperateDto:= "testCreateBuiltInRule"
	builtinRuleIdDataClassificationRuleOperateDto:= "a5adcca681f011e9a870765a9db3b202"
	nameDataClassificationRuleOperateDto:= "Bank_Account"
	secrecyLevelIdDataClassificationRuleOperateDto:= "8a9480ad7e992660017e9a381244000d"
	ruleTypeDataClassificationRuleOperateDto:= model.GetDataClassificationRuleOperateDtoRuleTypeEnum().BUILTIN
	request.Body = &model.DataClassificationRuleOperateDto{
		CategoryId: &categoryIdDataClassificationRuleOperateDto,
		Description: &descriptionDataClassificationRuleOperateDto,
		BuiltinRuleId: &builtinRuleIdDataClassificationRuleOperateDto,
		Name: &nameDataClassificationRuleOperateDto,
		SecrecyLevelId: &secrecyLevelIdDataClassificationRuleOperateDto,
		RuleType: &ruleTypeDataClassificationRuleOperateDto,
	}
	response, err := client.CreateSecurityDataClassificationRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

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

状态码

状态码	描述
200	ok
400	Bad Request

父主题：识别规则接口

上一篇：查询识别规则列表

下一篇：查询特定识别规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建识别规则

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线