DocsICP FilingConsole
Documentation

DescribeDcdnWafDomain

Updated at:
Copy as MD
Product
My Favorites

Queries the full list of domain names protected by WAF and the information about accelerated domain names that have WAF enabled, including the ACL status, CC status, creation status, and WAF enabling status of the accelerated domain names.

Operation description

This API operation applies to legacy WAF protection.

Note

Rate limit per user: 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 WAF management region.

Valid values:

  • ap-southeast-1 :

    The WAF management region outside the Chinese mainland.

  • cn-hangzhou :

    The WAF management region in the Chinese mainland.

cn-hangzhou
DomainName

string

No

The accelerated domain name. If this parameter is left empty, all accelerated domain names are returned.

example.com
ResourceGroupId

string

No

The resource group. If this parameter is left empty, the default resource group is used.

/

Response elements

Element

Type

Description

Example

object

TotalCount

integer

The number of accelerated domain names.

1
RequestId

string

The request ID.

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

array<object>

The information about the accelerated domain names.

object

AclStatus

integer

The ACL status. Valid values:

  • 0: Disabled.

  • 1: Enabled.

1
Status

integer

The domain name creation status. Valid values:

  • 1: The domain name is created or valid.

  • 10: The domain name is being created.

  • 11: The domain name fails to be created.

1
Domain

string

The accelerated domain name that has WAF enabled.

example.com
CcStatus

integer

The CC status. Valid values:

  • 0: Disabled.

  • 1: Enabled.

1
WafStatus

integer

The WAF status. 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.