Modifying a Sensitive Data Scanning Rule

Updated on 2023-12-07 GMT+08:00

View PDF

Function

This API is used to modify a sensitive data scanning rule.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request body 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: BUILT_IN BUILT_SELF
id	Yes	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: KEYWORD REGEX NLP

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
msg	String	Returned message
status	String	Return status, for example, '200', '400'.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

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 sent

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

Status code: 400

Invalid request

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

Status Codes

Status Code	Description
200	Request sent
400	Invalid request

Error Codes

See Error Codes.

Parent topic: Sensitive Data Discovery

Previous topic: Creating a Sensitive Data Scanning Rule

Next topic: Deleting a Sensitive Data Scanning Rule

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel