You can call this operation to query sensitive data detection rules in Sensitive Data Discovery and Protection (SDDP).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeRules |
The operation that you want to perform. Set the value to DescribeRules. |
Category | Integer | No | 2 |
The content type of the sensitive data detection rule. Valid values:
|
CurrentPage | Integer | No | 1 |
The number of the page to return. |
CustomType | Integer | No | 1 |
The type of the sensitive data detection rule. Valid values:
|
Lang | String | No | zh |
The language of the request and response. Valid values:
|
Name | String | No | *** rule |
The name of the sensitive data detection rule. SDDP searches for sensitive data detection rules based on the name that you enter in fuzzy match mode. |
PageSize | Integer | No | 12 |
The number of entries to return on each page. |
RiskLevelId | Long | No | 1 |
The risk level ID of data that hits the sensitive data detection rule. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CurrentPage | Integer | 1 |
The page number of the returned page. |
Items |
The list of sensitive data detection rules that were queried. |
||
Category | Integer | 2 |
The content type of the sensitive data detection rule. Valid values:
|
CategoryName | String | Regular expression |
The name of the content type of the sensitive data detection rule. |
Content | String | (?:\\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|$) |
The content of the sensitive data detection rule. |
CustomType | Integer | 1 |
The type of the sensitive data detection rule. Valid values:
|
Description | String | The sensitive data detection rule is used to detect IP addresses. |
The description of the sensitive data detection rule. |
DisplayName | String | ****test |
The display name of the account used to create the sensitive data detection rule. |
GmtCreate | Long | 1545277010000 |
The time when the sensitive data detection rule was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
GmtModified | Long | 1545277010000 |
The time when the sensitive data detection rule was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
Id | Long | 20000 |
The unique ID of the sensitive data detection rule. |
LoginName | String | det1111 |
The username of the account used to create the sensitive data detection rule. |
Name | String | IP address |
The name of the sensitive data detection rule. |
RiskLevelId | Long | 2 |
The risk level ID of data that hits the sensitive data detection rule. Valid values:
|
RiskLevelName | String | S2 |
The risk level of data that hits the sensitive data detection rule. Valid values:
|
Status | Integer | 1 |
The status of the sensitive data detection rule. Valid values:
|
UserId | Long | 0 |
The ID of the account used to create the sensitive data detection rule. |
PageSize | Integer | 12 |
The number of entries returned per page. |
RequestId | String | 769FB3C1-F4C9-42DF-9B72-7077A8989C13 |
The ID of the request. |
TotalCount | Integer | 23 |
The total number of returned entries. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeRules
&<Common request parameters>
Sample success responses
XML
format
<DescribeRules>
<RequestId>769FB3C1-F4C9-42DF-9B72-7077A8989C13</RequestId>
<Items>
<Description>The sensitive data detection rule is used to detect IP addresses.</Description>
<Category>2</Category>
<GmtModified>1545277010000</GmtModified>
<RiskLevelId>2</RiskLevelId>
<Name>IP address</Name>
<GmtCreate>1545277010000</GmtCreate>
<UserId>0</UserId>
<Status>1</Status>
<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|$)</Content>
<CategoryName>Regular expression</CategoryName>
<RiskLevelName>S2</RiskLevelName>
<DepartName>test</DepartName>
<LoginName>det1111</LoginName>
<Id>2000</Id>
</Items>
<TotalCount>18</TotalCount>
<PageSize>10</PageSize>
<CurrentPage>1</CurrentPage>
</DescribeRules>
JSON
format
{
"Items":[
{
"Description":"The sensitive data detection rule is used to detect IP addresses.",
"CategoryName":"Regular expression",
"LoginName":"det1111",
"RiskLevelId":2,
"DepartName":"test",
"UserId":0,
"GmtCreate":1545277010000,
"GmtModified":1545277010000,
"Name":"IP address",
"Status":1,
"Category":2,
"RiskLevelName":"S2",
"Id":2000,
"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|$)"
}
],
"TotalCount":18,
"PageSize":10,
"RequestId":"769FB3C1-F4C9-42DF-9B72-7077A8989C13",
"CurrentPage":1
}
Error codes
For a list of error codes, visit the API Error Center.