DescribeDcdnWafPolicyValidDomains - Edge Security Acceleration

You can call DescribeDcdnWafPolicyValidDomains to query the domain names that can be attached to custom mitigation policies.

Operation description

Note

A single user can make up to 20 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:DescribeDcdnWafPolicyValidDomains

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DefenseScene	string	Yes	The type of the WAF mitigation policy. The following scenarios are supported: waf_group: Basic web protection custom_acl: Custom mitigation policies whitelist: Whitelist ip_blacklist: IP blacklist region_block: Location Blacklist bot: Bot management	custom_acl
DomainNameLike	string	No	The protected domain name. Fuzzy queries are supported.	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 display on each page. Default value: 20. Valid values: an integer from 1 to 500.	20

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of domain names displayed on each page. This is the same as the PageSize in the request.	20
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630
PageNumber	integer	The page number. This is the same as the PageNumber in the request.	1
TotalCount	integer	The total number of domain names found.	2
Domains	array<object>	The list of protected domain names.
	object
PolicyName	string	The name of the mitigation policy.	test1
PolicyId	integer	The ID of the mitigation policy.	1000001
DomainName	string	The protected domain name.	example.com
PolicyType	string	Indicates whether this is the default mitigation policy. Valid values: default: The policy is the default one. custom: The policy is not the default one.	default
Policies	array<object>	The policies attached to the domain name.
	object
Id	integer	The policy ID.	10000002
Name	string	The policy name.	test2
Type	string	The policy type.	custom

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630",
  "PageNumber": 1,
  "TotalCount": 2,
  "Domains": [
    {
      "PolicyName": "test1",
      "PolicyId": 1000001,
      "DomainName": "example.com",
      "PolicyType": "default",
      "Policies": [
        {
          "Id": 10000002,
          "Name": "test2",
          "Type": "custom"
        }
      ]
    }
  ]
}

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.