Docs
api
Web Application Firewall(UEWAF)
DescribeWafSystemRules

Query the system default rules for the specified domain name - DescribeWafSystemRules

Overview

Query the system default rules for the specified domain name

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeWafSystemRules.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, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
FullDomainstringDomain to queryYes

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
Rulesarray[SystemRuleInfo]List of rule contents, refer to SystemRuleInfoNo

Data Model

SystemRuleInfo

Field NameTypeDescription InformationRequired
SysRulesetintStart Rule NumberNo
ActionstringActionNo
RiskRankstringRisk LevelNo
RulesetTypestringRule Set TypeNo
PriorityintPriorityNo
AttackTypestringAttack TypeNo
DescriptionstringRule DescriptionNo

Example

Request Example

https://api.dezai.com/?Action=DescribeWafSystemRules
&ProjectId=org-xxx
&FullDomain=www.test.com

Response Example

{
  "Action": "DescribeWafSystemRulesResponse",
  "RetCode": 0,
  "Rules": [
    {
      "Action": "ACCEPT",
      "AttackType": "default",
      "Description": "默认放行-未做归类",
      "Priority": 1,
      "RiskRank": "high",
      "RulesetType": "system",
      "SysRuleset": 10000
    }
  ]
}