All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnWafDomain

    Document Center

    Edge Security Acceleration:DescribeDcdnWafDomain

    Last Updated:Sep 11, 2025

    Call the DescribeDcdnWafDomain operation to query a list of all domain names that are protected by Web Application Firewall (WAF) and information about these domain names. The information includes the Access Control List (ACL) status, Challenge Collapsar (CC) protection status, creation status, and WAF status.

    Operation description

    Note

    The call frequency for a single user is 150 calls per second.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dcdn:DescribeDcdnWafDomain

    get

    *Domain

    acs:dcdn:*:{#accountId}:domain/{#domainName}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The management region of WAF.

    cn-hangzhou
    DomainName

    string

    No

    The accelerated domain name. If you do not specify this parameter, information about all accelerated domain names is returned.

    example.com
    ResourceGroupId

    string

    No

    The ID of the resource group. If you do not specify this parameter, the default resource group is used.

    /

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of accelerated domain names.

    1
    RequestId

    string

    The ID of the request.

    CB1A380B-09F0-41BB-802B-72F8FD6DA2FE
    OutPutDomains

    array<object>

    The information about the accelerated domain names.

    object

    AclStatus

    integer

    The status of the access control list (ACL) feature. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    1
    Status

    integer

    The creation status of the domain name. Valid values:

    • 1: The domain name is valid.

    • 10: The domain name is being created.

    • 11: The creation of the domain name failed.

    1
    Domain

    string

    The accelerated domain name for which WAF is enabled.

    example.com
    CcStatus

    integer

    The status of the CC protection feature. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    1
    WafStatus

    integer

    The status of the WAF feature. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    1

    Examples

    Success response

    JSON format

    {
  "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.