DescribeCdnWafDomain-阿里云帮助中心

Operation description

Note

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

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

cdn:DescribeCdnWafDomain

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where WAF is enabled. Valid values: cn-hangzhou: inside the Chinese mainland ap-southeast-1: outside the Chinese mainland Note ap-southeast-1 includes Hong Kong (China), Macao (China), Taiwan (China), and other countries and regions.	cn-hangzhou
DomainName	string	No	The domain name that you want to query. You can specify only one domain name in each request. You have three options to configure this parameter: Specify an exact domain name. For example, if you set this parameter to example.com, configuration information of example.com is queried. Specify a keyword. For example, if you set this parameter to example, configuration information about all domain names that contain example is queried. Leave this parameter empty. If this parameter is left empty, all accelerated domain names for which WAF is configured are queried.	example.com
ResourceGroupId	string	No	The ID of the resource group.	1234

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The 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 name.
	object
AclStatus	string	The status of the access control list (ACL) feature. Valid values: 0: disabled 1: enabled	1
Status	string	The WAF status of the domain name. Valid values: 1: The domain name is added to WAF or valid. 10: The domain name is being added to WAF. 11: The domain name failed to be added to WAF.	1
Domain	string	The accelerated domain name.	example.com
CcStatus	string	The status of protection against HTTP flood attacks. Valid values: 0: disabled 1: enabled	1
WafStatus	string	The status of WAF. 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
400	InvalidParameter	InvalidParameter.
400	InvalidParameterRegionId	Invalid Region ID.
400	InvalidParameterDomain	Invalid Domain Name.
400	DomainNotExist	Specified Domain Not Exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.