Viewing the Rule List
Function
This API is used to query the sensitive data scanning rule list. The total number of rules and the rule list are returned.
URI
GET /v1/{project_id}/sdg/server/scan/rules
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
offset |
No |
Integer |
Page number |
limit |
No |
Integer |
Page limit |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
rules |
Array of ResponseRule objects |
Rule list |
total |
Integer |
Total number of rules |
Parameter |
Type |
Description |
|---|---|---|
category |
String |
Rule type, which can be built-in rule (BUILT_IN) or self-built rule (BUILT_SELF). Enumeration values:
|
delete_allowed |
Boolean |
Whether deletion is allowed |
group_names |
String |
Rule group |
id |
String |
Rule ID |
logic_operator |
String |
Logical operators: "AND", "OR", and "REGEX". |
min_match |
Integer |
Minimum matching times |
risk_level |
Integer |
Risk level |
rule_content |
String |
Rule content |
rule_desc |
String |
Rule description |
rule_name |
String |
Rule name |
rule_type |
String |
Rule type, which can be keyword (KEYWORD), regular expression (REGEX), or natural language (NLP). Enumeration values:
|
selected |
Boolean |
Whether the parameter is optional |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Query the sensitive data scanning rule list.
GET /v1/{project_id}/sdg/server/scan/rules
Example Responses
Status code: 200
Request sent
{
"total" : 1,
"rules" : [ {
"category" : "BUILT_SELF",
"delete_allowed" : true,
"group_names" : "xxxx",
"id" : "xxxxxxxxxxxx",
"logic_operator" : "AND",
"min_match" : 1,
"risk_level" : 1,
"rule_content" : "xxxx",
"rule_desc" : "xxxx",
"rule_name" : "xxxx",
"rule_type" : "KEYWORD",
"selected" : true
} ]
}
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.
