All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnWafDomains

Last Updated:Apr 11, 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnWafDomainsRead
  • All Resources
    *
    none
none

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
Domainsobject []

The protected domain name.

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.