Get Domain Whitelist - DescribeWafDomainWhiteList

Overview

Get Domain Whitelist

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWafDomainWhiteList`.	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, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
FullDomain	string	Domain of the whitelist to be obtained	Yes
Limit	int	Each request limits the return quantity, equivalent to page size	Yes
Offset	int	Offset, equivalent to page number	Yes
Filter	string	The IP, network segment, or IP segment you want to search for, pass the array (CIDRS).	No

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
Res	BWInfoRes	Return result of whitelist, refer to BWInfoRes	Yes

Data Model

BWInfoRes

Field Name	Type	Description Information	Required
Total	int	Total	No
Count	int	Return Quantity	No
Info	array[BWInfo]	Detail list, refer to BWInfo	No

BWInfo

Field Name	Type	Description Information	Required
ID	int	Blacklist/Whitelist Rule ID	No
Type	string	Type	No
Source	string	Join Method (Black)	No
CIDRS	array[string]	IP List	No
CreateTime	string	Join Time	No
ExpireTime	int	Expiration Time	No
State	int	Status	No
SRC	string	Join Method (White)	No
Name	string	Rule Name	No
Remark	string	Note Information	No

Example

Request Example


https://api.surfercloud.com/?Action=DescribeWafDomainWhiteList
&ProjectId=org-xxx
&FullDomain=www.test.com
&Offset=0
&Limit=10

Response Example


{
  "Action": "DescribeWafDomainWhiteListResponse",
  "Res": {
    "Count": 1,
    "Info": [
      {
        "ActionType": "accept",
        "CIDRS": [
          "1.1.1.1"
        ],
        "CreateTime": "2020-02-27 09:50:10",
        "ExpireTime": 0,
        "ID": 15022,
        "Name": "",
        "Remark": "",
        "SRC": "custom",
        "Source": "",
        "State": 0,
        "Type": ""
      }
    ],
    "Total": 1
  },
  "RetCode": 0
}