Query Region IP Block Rules - GetWafRegionBlockRule

Overview

Query Area IP Block Record

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetWafRegionBlockRule`.	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 Query	Yes
Offset	int	Paging Query Offset Setting	Yes
Limit	int	Limit of Number of Pages	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
Count	int	Number of Rules	No
RuleList	array[RegionBlackInfo]	Rule list, refer to RegionBlackInfo	No

Data Model

RegionBlackInfo

Field Name	Type	Description Information	Required
ID	int	Rule ID	No
Name	string	Rule Name	No
FullDomain	string	Belonging Domain	No
Action	string	Execute Action	No
Regions	string	Effective Area	No
Description	string	Rule Description	No
TopOrganizationId	int	User ID	No
OrganizationId	int	Project ID	No

Example

Request Example


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

Response Example


{
  "Action": "GetWafRegionBlockRuleResponse",
  "Count": 1,
  "RetCode": 0,
  "RuleList": [
    {
      "Action": "Deny",
      "Description": "全部",
      "FullDomain": "*.8cname.com",
      "ID": 1115,
      "Name": "1",
      "OrganizationId": 50148127,
      "Regions": "!CN",
      "TopOrganizationId": 50146955
    }
  ]
}