Query Auto-Add Blacklist Policy - DescribeAutoWafDomainBlackList
Overview
Query Auto-Add Blacklist Policy
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeAutoWafDomainBlackList . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
FullDomain | string | Domain Name | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Rows | array[AutoWafDomainBlackList] | Automatic interception strategy list, refer to AutoWafDomainBlackList | No |
TotalCount | int | Number of Automatic Interception Strategies | No |
Data Model
AutoWafDomainBlackList
Field Name | Type | Description Information | Required |
---|---|---|---|
Id | int | Rule ID | Yes |
FullDomain | string | Domain of the Rule | Yes |
AttackType | string | Attack Type | Yes |
ActionType | string | Defense Mode | Yes |
AttackCount | int | Number of Attacks | Yes |
IntervalTime | int | Attack Statistics Interval, Unit: Seconds | Yes |
ExpireTime | int | Attack expiration interval, unit: seconds | Yes |
Enable | int | Enable Status; 1 indicates enabled, 0 indicates disabled | Yes |
CreateTime | int | Creation Time | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=DescribeAutoWafDomainBlackList
&ProjectId=org-xxx
&FullDomain=www.test.com
Response Example
{
"Action": "DescribeAutoWafDomainBlackListResponse",
"RetCode": 0,
"Rows": [
{
"ActionType": "forbidden",
"AttackCount": 10,
"AttackType": "all",
"CreateTime": 1585192039,
"Enable": 1,
"ExpireTime": 60,
"FullDomain": "www.test.com",
"Id": 591,
"IntervalTime": 60
},
{
"ActionType": "forbidden",
"AttackCount": 10,
"AttackType": "protocol",
"CreateTime": 1585878780,
"Enable": 1,
"ExpireTime": 60,
"FullDomain": "www.test.com",
"Id": 603,
"IntervalTime": 60
}
],
"TotalCount": 2
}