Get WAF Protection Domain List - DescribeWafDomainHostInfo

Overview

Get WAF Protection Domain List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWafDomainHostInfo`.	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
Limit	int	Limit per page (Equivalent to page size)	Yes
Offset	int	Page Offset (Equivalent to page number)	Yes
FullDomain	string	Domain name, used for querying a single domain name	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
TotalCount	int	Total Number of Domains	No
DomainHostList	array[HostStatausInfo]	Domain information list, refer to HostStatausInfo	No

Data Model

HostStatausInfo

Field Name	Type	Description Information	Required
FullDomain	string	Domain Name	No
WorkMode	string	Working Mode	No
RecordId	int	Domain Record ID	No
CertificateID	int	Certificate ID	No
Cname	string	CNAME Record Value	No
WorkRegions	string	Deployment Area	No
AntiCC	string	Enable CC Protection?	No
Assurance	string	Whether to enable web page tampering prevention	No
CreateTime	int	Create Timestamp	No
SrcIPInfo	array[SrcIPInfo]	Source IP address information, see SrcIPInfo	No
HTTPRedirection	string	HTTP redirection	No
HTTPBack	string	Enable HTTPS offload, YES - Yes	No
HttpStatus	string	HTTP Status Description, WAF Active Detection Results	No
HttpException	string	HTTP Exception Information, WAF Active Detection Results	No
HttpsStatus	string	HTTPS status, WAF active detection result	No
HttpsException	string	HTTPS Exception Description, WAF Active Detection Result	No
UniqueIP	string	Is the IP address exclusive?	No
RealIPHeader	string	Real IP Header	No
AttackCount	int	Attack Times	No
DomainStatus	array[DomainStatus]	WAF detects domain status information, refer to DomainStatus, ULB version is invalid.	No
Status	int	Domain validity, ULB version is valid, other versions are invalid, 1 indicates that the domain is normally connected, 0 indicates that the domain has been deleted from ULB, WAF only retains historical records.	No

SrcIPInfo

Field Name	Type	Description Information	Required
Proto	string	Protocol	No
SrcIP	string	Source IP Address	No
Port	array[int]	Source Port	No
URI	string	URI	No

DomainStatus

Field Name	Type	Description Information	Required
Region	string	Deployment Area	No
Scheme	string	Protocol	No
Status	string	Status Information	No
RawStatus	string	Original Status Information	No

Example

Request Example


https://api.sigcalcloud.com/?Action=DescribeWafDomainHostInfo
&ProjectId=org-xxx
&Offset=0
&Limit=10

Response Example


{
  "Action": "DescribeWafDomainHostInfoResponse",
  "DomainHostList": [
    {
      "AntiCC": "on",
      "Assurance": "off",
      "AttackCount": 0,
      "CertificateID": 0,
      "Cname": "ce43b831.uewaf.com",
      "CreateTime": 1584695681,
      "DefenceIps": {
        "cn-bj": [
          "106.7.27.194"
        ],
        "cn-gd": [
          "106.7.185.203"
        ]
      },
      "DomainStatus": [
        {
          "RawStatus": "Head http://106.5.185.203:80/: EOF",
          "Region": "cn-gd",
          "Scheme": "http",
          "Status": "Exception"
        },
        {
          "RawStatus": "Head http://106.5.27.194:80/: EOF",
          "Region": "cn-bj",
          "Scheme": "http",
          "Status": "Exception"
        }
      ],
      "FullDomain": "www.test.com",
      "HTTPRedirection": "NO",
      "HttpException": "Head http://106.5.27.194:80/: EOF",
      "HttpStatus": "Exception",
      "HttpsException": "",
      "HttpsStatus": "Unaccess",
      "RealIPHeader": "default",
      "RecordId": 46103,
      "SrcIPInfo": [
        {
          "Port": [
            80
          ],
          "Proto": "http",
          "SrcIP": "152.32.70.130",
          "URI": "http://152.32.170.130:80"
        }
      ],
      "UniqueIP": "NO",
      "WorkMode": "Alarm",
      "WorkRegions": "cn-bj,cn-gd"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}