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.
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"
}
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.
