Get Protection Rule List - DescribeWafProtectionSummaryInfo

Overview

Get Protection Rule List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWafProtectionSummaryInfo`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	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, and the sub-account must be filled in. Please refer to the GetProjectList interface.	No
FullDomain	string	Domain to query	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
TotalCount	int	Number of Rules	No
WorkMode	string	Working Mode	No
RuleSetList	array[ProtectionSummaryRuleSetEntry]	Rule set list, refer to ProtectionSummaryRuleSetEntry	No

Data Model

ProtectionSummaryRuleSetEntry

Field Name	Type	Description Information	Required
RuleName	string	Rule Name	No
RuleAction	string	Rule Action	No
Priority	int	Priority	No
RiskRank	string	Risk Level	No
RiskType	string	Risk Type	No
RuleSetID	int	Rule Set ID	No
RuleSetType	string	Rule Set Type	No
SysRuleset	int	Start ID of Rule Set	No
RuleDescription	string	Rule Description	No
RuleList	array[ProtectionSummaryRuleInfo]	For rule details, refer to ProtectionSummaryRuleInfo	No

ProtectionSummaryRuleInfo

Field Name	Type	Description Information	Required
Field	string	Match Field	No
Operator	string	Behavior Action	No
Content	string	Matching Content	No
RuleId	int	Rule ID	No
Description	string	Rule Description	No

Example

Request Example


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

Response Example


{
  "Action": "DescribeWafProtectionSummaryInfoReponse",
  "RetCode": 0,
  "RuleSetList": [
    {
      "Location": "root",
      "Phase": "access",
      "Priority": 0,
      "RiskRank": "High",
      "RiskType": "scan",
      "RuleAction": "Deny",
      "RuleDescription": "",
      "RuleList": [
        {
          "Content": "2.2.2.2",
          "Description": "",
          "Field": "SrcIp",
          "Operator": "Contain",
          "RuleId": 45000,
          "UserRuleId": 45001
        }
      ],
      "RuleName": "test",
      "RuleSetID": 45000,
      "RuleSetType": "",
      "SysRuleset": 90045000
    }
  ],
  "TotalCount": 1,
  "WorkMode": "Alarm"
}