DescribeDcdnWafDomain - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries domain names that have Web Application Firewall (WAF) enabled and the relevant information, including the status of the access control list (ACL), protection against HTTP flood attacks, domain name, and WAF.

Operation description

Note You can call this operation up to 50 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where WAF is enabled. Enumeration Value: cn-hangzhou ap-southeast-1	cn-hangzhou
DomainName	string	No	The accelerated domain name. If you do not specify an accelerated domain name, all accelerated domain names are queried.	example.com
ResourceGroupId	string	No	The ID of the resource group. If you leave this parameter empty, the default resource group is used.	/

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The number of accelerated domain names returned.	1
RequestId	string	The ID of the request.	CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
OutPutDomains	array<object>	The accelerated domain name.
OutPutDomain	object
AclStatus	integer	The status of the ACL. Valid values: 0: disabled 1: enabled	1
Status	integer	The status of the domain name. Valid values: 1: The domain name is added to WAF, or the domain name is valid. 10: The domain name is being added to WAF. 11: The domain name failed to be added to WAF.	1
Domain	string	The domain name that has WAF enabled.	example.com
CcStatus	integer	The status of protection against HTTP flood attacks. Valid values: 0: disabled 1: enabled	1
WafStatus	integer	The status of WAF. Valid values: 0: disabled 1: enabled	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "CB1A380B-09F0-41BB-802B-72F8FD6DA2FE",
  "OutPutDomains": [
    {
      "AclStatus": 1,
      "Status": 1,
      "Domain": "example.com",
      "CcStatus": 1,
      "WafStatus": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.
400	InvalidDomainName	The specified DomainName is invalid.	The DomainName parameter is set to an invalid value. Specify a valid value and try again.
404	InvalidDomain.NotFound	The specified domain does not exist.	The specified domain name does not exist.

For a list of error codes, visit the Service error codes.