Queries sensitive data detection rules.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Lang | string | No | The language of the content within the request and response. Valid values:
| zh |
PageSize | integer | No | The number of entries to return on each page. | 12 |
CurrentPage | integer | No | The page number of the page to return. | 1 |
CustomType | integer | No | The type of the sensitive data detection rule. Valid values:
| 1 |
Category | integer | No | The content type of the sensitive data detection rule. Valid values:
| 2 |
Name | string | No | The name of the sensitive data detection rule. Fuzzy match is supported. | \*\*\* rule |
RiskLevelId | long | No | The sensitivity level of the sensitive data that hits the sensitive data detection rule. Valid values:
| 2 |
RuleType | integer | No | The type of the sensitive data detection rule. Valid values:
| 1 |
MatchType | integer | No | The match type. Valid values:
| 1 |
ProductCode | integer | No | The name of the service to which the data asset belongs. Valid values include MaxCompute, OSS, ADS, OTS, and RDS. | MaxCompute |
ProductId | long | No | The ID of the service to which the sensitive data detection rule is applied. Valid values include 1, 2, 3, 4, and 5. The value 1 indicates MaxCompute. The value 2 indicates Object Storage Service (OSS). The value 3 indicates AnalyticDB for MySQL. The value 4 indicates Tablestore. The value 5 indicates ApsaraDB RDS. | 1 |
WarnLevel | integer | No | The severity level of the alert. Valid values:
| 2 |
ContentCategory | integer | No | The type of the content in the sensitive data detection rule. Valid values include 1, 2, 3, 4, and 5. The value 1 indicates attempts to exploit SQL injections. The value 2 indicates bypass by using SQL injections. The value 3 indicates abuse of stored procedures. The value 4 indicates buffer overflow. The value 5 indicates SQL injections based on errors. | 1 |
Status | integer | No | The status of the sensitive data detection rule. Valid values:
| 1 |
KeywordCompatible | boolean | No | Specifies whether to allow earlier versions of request parameters to support keywords that are supported in later versions of request parameters. Valid values:
Note
To specify keywords as the content type of the sensitive data detection rule, you can set the Category parameter to 0 for earlier versions of request parameters and set the Category parameter to 5 for later versions of request parameters. You can specify the KeywordCompatible parameter based on your business requirements.
| true |
GroupId | string | No | The parent group type of the rule. | 4_1 |
SupportForm | integer | No | The type of the data asset. Valid values:
Note
If you set the parameter to 1 or 2, rules that support all data assets and rules that support the queried data asset type are returned.
| 1 |
FeatureType | integer | No | This parameter is deprecated. | 2 |
Response parameters
Examples
Sample success responses
JSON
format
{
"CurrentPage": 1,
"RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
"PageSize": 12,
"TotalCount": 23,
"Items": [
{
"DisplayName": "****test",
"Status": 1,
"SupportForm": 2,
"WarnLevel": 2,
"UserId": 0,
"StatExpress": "1",
"GmtModified": 1545277010000,
"RiskLevelId": 2,
"Description": "The sensitive data detection rule is used to detect IP addresses.\n",
"ProductId": 2,
"Name": "IP address\n",
"Content": "(?:\\\\D|^)((?:(?:25[0-4]|2[0-4]\\\\d|1\\\\d{2}|[1-9]\\\\d{1})\\\\.)(?:(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d?\\\\d)\\\\.){2}(?:25[0-5]|2[0-4]\\\\d|1[0-9]\\\\d|[1-9]\\\\d|[1-9]))(?:\\\\D|$)",
"Target": "MaxCompute",
"LoginName": "det1111",
"CategoryName": "Regular expression\n",
"ContentCategory": "1",
"HitTotalCount": 3,
"GroupId": "4_1",
"CustomType": 1,
"RiskLevelName": "S2",
"GmtCreate": 1545277010000,
"Category": 2,
"MajorKey": "key",
"Id": 20000,
"ProductCode": "MaxCompute",
"MatchType": 1
}
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2024-03-25 | The request parameters of the API has changed | see changesets | ||||
| ||||||
2023-07-17 | The request parameters of the API has changed | see changesets | ||||
|