DescribeDcdnWafPolicyValidDomains - Edge Security Acceleration

Queries the domain names that can be bound to a custom protection policy.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DefenseScene	string	Yes	The type of the Web Application Firewall (WAF) protection policy. Valid values: waf_group: basic web protection custom_acl: custom protection whitelist: IP address whitelist ip_blacklist: IP address blacklist region_block: region blacklist bot: bot management	custom_acl
DomainNameLike	string	No	The protected domain name. Fuzzy search is supported.	example.com
PageNumber	integer	No	The page number of the returned page. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of domain names to return on each page. Valid values: an integer from 1 to 500. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of domain names returned per page, which is the same as the PageSize parameter in request parameters.	20
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630
PageNumber	integer	The page number of the returned page, which is the same as the PageNumber parameter in request parameters.	1
TotalCount	integer	The total number of domain names returned.	2
Domains	array<object>	The information about the protected domain names.
DomainItem	object
PolicyName	string	The name of the protection policy.	test1
PolicyId	long	The ID of the protection policy.	1000001
DomainName	string	The protected domain name.	example.com
PolicyType	string	Indicates whether the protection policy is the default policy. Valid values: default: The protection policy is the default policy. custom: The protection policy is not the default policy.	default
Policies	array<object>	The policy that is bound to the domain name.
Policy	object
Id	long	The ID of the rule.	10000002
Name	string	The name of the policy.	test2
Type	string	The type of the policy.	custom

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.