Docs
api
Web Application Firewall(UEWAF)
GetWafRegionBlockRule

Query Region IP Block Rules - GetWafRegionBlockRule

Overview

Query Area IP Block Record

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetWafRegionBlockRule.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 QueryYes
OffsetintPaging Query Offset SettingYes
LimitintLimit of Number of PagesYes

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
CountintNumber of RulesNo
RuleListarray[RegionBlackInfo]Rule list, refer to RegionBlackInfoNo

Data Model

RegionBlackInfo

Field NameTypeDescription InformationRequired
IDintRule IDNo
NamestringRule NameNo
FullDomainstringBelonging DomainNo
ActionstringExecute ActionNo
RegionsstringEffective AreaNo
DescriptionstringRule DescriptionNo
TopOrganizationIdintUser IDNo
OrganizationIdintProject IDNo

Example

Request Example

https://api.dezai.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
    }
  ]
}