Query Information Security Filtering Rules - DescribeWafResponseFilter

Overview

Query Information Security Filtering Rules

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWafResponseFilter`.	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
Data	array[HttpReponseFilter]	Information security filter rule list, refer to HttpReponseFilter	Yes

Data Model

HttpReponseFilter

Field Name	Type	Description Information	Required
ID	int	Rule ID	No
Name	string	Rule Name	No
Type	string	Protection type; Optional: Status (Status code), Sensitive (Sensitive content), Customize (Custom string)	No
Content	string	Filter Content	No
RuleAction	string	Discard response or disguise content	No
DisguiseFile	string	Fake Response Content	No

Example

Request Example


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

Response Example


{
  "Action": "DescribeWafHttpResponseFilterResponse",
  "Data": [
    {
      "Content": "TelNum",
      "DisguiseFile": "",
      "ID": 3000,
      "Name": "手机号",
      "RuleAction": "DROP",
      "Type": "Sensitive"
    },
    {
      "Content": "403",
      "DisguiseFile": "403403",
      "ID": 2000,
      "Name": "43",
      "RuleAction": "DISGUISE",
      "Type": "Status"
    },
    {
      "Content": "404",
      "DisguiseFile": "",
      "ID": 1000,
      "Name": "404",
      "RuleAction": "DROP",
      "Type": "Status"
    }
  ],
  "RetCode": 0
}