Creating a Sensitive Data Scanning Rule
Function
This API is used to create a sensitive data scanning rule using the parameters such as rule name, rule type, risk level, and minimum number of matching times.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/sdg/server/scan/rules
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
category |
Yes |
String |
Rule type, which can be built-in rule (BUILT_IN) or self-built rule (BUILT_SELF). Enumeration values:
|
id |
No |
String |
Rule ID |
logic_operator |
Yes |
String |
Logical operators: "AND", "OR", and "REGEX". |
min_match |
Yes |
Integer |
Minimum matching times |
risk_level |
Yes |
Integer |
Risk level |
rule_content |
Yes |
String |
Rule content |
rule_desc |
No |
String |
Rule description |
rule_name |
Yes |
String |
Rule name |
rule_type |
Yes |
String |
Rule type, which can be keyword (KEYWORD), regular expression (REGEX), or natural language (NLP). Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
msg |
String |
Returned message |
status |
String |
Return status, for example, '200', '400'. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Create a sensitive data scanning rule.
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" }
Example Responses
Status code: 200
Request sent
{ "msg" : "xxxx", "status" : "RESPONSE_SUCCESS" }
Status code: 400
Invalid request
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
SDK Sample Code
The SDK sample code is as follows.
Create a sensitive data scanning rule.
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 |
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"); ICredential auth = new BasicCredentials() .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()); } } } |
Create a sensitive data scanning rule.
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 |
# 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"] credentials = BasicCredentials(ak, sk) 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) |
Create a sensitive data scanning rule.
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" 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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). 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) } } |
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 sent |
400 |
Invalid request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot