All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnWafDomains

Last Updated:Oct 17, 2024

Queries the accelerated domain names that are protected by Web Application Firewall (WAF). Fuzzy search is supported.

Operation description

You can call this operation up to 20 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
QueryArgsstringNo

The query conditions. You can filter domain names by name. Fuzzy match is supported QueryArgs={"DomainName":"Accelerated domain name"}

{"DomainName":"example.com"}
PageNumberintegerNo

The number of the page to return. Valid values: 1 to 100000.

Default value: 1.

1
PageSizeintegerNo

The number of domain names to return on each page. Valid values: an integer from 1 to 500. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of domain names returned per page, which is the same as the PageSize parameter in request parameters.

20
RequestIdstring

The ID of the request.

153ca2cd-3c01-44be-b408-64dbc6c88630
PageNumberinteger

The page number of the returned page, which is the same as the PageNumber parameter in request parameters.

1
TotalCountinteger

The total number of protected domain names.

15
Domainsarray<object>

The protected domain name.

DomainItemobject
PolicyCountinteger

The number of protection policies that were configured for the protected domain name.

3
ClientIpTagstring

The header of IP address of the client that is connected to the point of presence (POP).

X-Forwarded-For
DomainNamestring

The protected domain name.

example.com

Examples

Sample success responses

JSONformat

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-b408-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Domains": [
    {
      "PolicyCount": 3,
      "ClientIpTag": "X-Forwarded-For",
      "DomainName": "example.com"
    }
  ]
}

Error codes

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