DescribeDcdnWafDomains - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryArgs	string	No	The query conditions. Fuzzy match for domain names is supported. `QueryArgs={"DomainNameLike":"accelerated domain name"}`	{"DomainNameLike":"example.com"}
PageNumber	integer	No	The page number. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of domain names to return on each page. Valid values: 1 to 500. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of domain names returned on each page. This value is the same as the PageSize request parameter.	20
RequestId	string	The request ID.	153ca2cd-3c01-44be-b408-64dbc6c88630
PageNumber	integer	The page number. This value is the same as the PageNumber request parameter.	1
TotalCount	integer	The total number of protected domain names.	15
Domains	array<object>	The protected domain names.
	object
PolicyCount	integer	The number of mitigation policies configured for the protected domain name.	3
ClientIpTag	string	The header used to obtain the client IP address.	X-Forwarded-For
DomainName	string	The protected domain name.	example.com

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.