Docs
api
Web Application Firewall(UEWAF)
DescribeAutoWafDomainBlackList

Query Auto-Add Blacklist Policy - DescribeAutoWafDomainBlackList

Overview

Query Auto-Add Blacklist Policy

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeAutoWafDomainBlackList.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
FullDomainstringDomain NameYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
Rowsarray[AutoWafDomainBlackList]Automatic interception strategy list, refer to AutoWafDomainBlackListNo
TotalCountintNumber of Automatic Interception StrategiesNo

Data Model

AutoWafDomainBlackList

Field NameTypeDescription InformationRequired
IdintRule IDYes
FullDomainstringDomain of the RuleYes
AttackTypestringAttack TypeYes
ActionTypestringDefense ModeYes
AttackCountintNumber of AttacksYes
IntervalTimeintAttack Statistics Interval, Unit: SecondsYes
ExpireTimeintAttack expiration interval, unit: secondsYes
EnableintEnable Status; 1 indicates enabled, 0 indicates disabledYes
CreateTimeintCreation TimeYes

Example

Request Example

https://api.dezai.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
}