DescribeDcdnWafPolicies - Edge Security Acceleration

Queries the details of the Web Application Firewall (WAF) protection policies that you configured.

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
QueryArgs	string	No	The query conditions. The value is a JSON string. The format is `QueryArgs={"PolicyIds":"The IDs of protection policies","RuleIds":"The IDs of protection rules","PolicyNameLike":"The name of the protection policy","DomainNames":"The protected domain names","PolicyType":"default","DefenseScenes":"waf_group","PolicyStatus":"on","OrderBy":"GmtModified","Desc":"false"}` Note If you do not set this parameter, all protection policies are queried.	{"PolicyNameLIike":"test_policy"}
PageNumber	integer	No	The number of the page to return. Valid values: 1 to 100000. Default value: 1.	1
PageSize	integer	No	The number of protection policies to return on each page. Valid values: an integer from 1 to 500. Default value: 20.	20

Fields in the QueryArgs parameter

Name	Type	Required	Example	Description
PolicyIds	string	No	10000001,10000002	The IDs of protection policies. Separate multiple IDs with commas (,). Only exact match is supported.
RuleIds	string	No	20000001,20000055	The IDs of protection rules. Separate multiple IDs with commas (,). Only exact match is supported.
PolicyType	string	No	default	Specifies whether the protection policy is the default policy. Valid values: default custom
DefenseScenes	string	No	custom_acl	The types of protection policies. Separate multiple types with commas (,). Only exact search is supported. Valid values: waf_group: basic web protection custom_acl: custom protection whitelist: whitelist
PolicyStatus	string	No	on	The status of the policy. on off
OrderBy	string	No	GmtModified	The field that is used to sort query results. Valid values: GmtModified, PolicyId, PolicyName, and PolicyStatus.
Desc	Boolean	No	false	The sort order. The value true indicates the reverse chronological order. The value false indicates the chronological order. Default value: false.

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of protection policies returned per page. Valid values: an integer from 1 to 500. Default value: 20.	20
RequestId	string	The ID of the request.	153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumber	integer	The page number of the returned page. Valid values: 1 to 100000. Default value: 1.	1
TotalCount	integer	The total number of protection policies.	15
Policies	array<object>	The information about protection policies.
PolicyItem	object
PolicyStatus	string	The status of the protection policy, which is the same as the PolicyStatus field in the QueryArgs parameter.	on
DefenseScene	string	The type of the protection policy, which is the same as the DefenseScenes field in the QueryArgs parameter.	custom_acl
DomainCount	integer	The number of domain names that use the protection policy.	22
PolicyName	string	The name of the protection policy.	policy_test
PolicyId	long	The ID of the protection policy.	100001
RuleCount	long	The number of protection rules in the protection policy.	9
GmtModified	string	The time when the protection policy was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-29T17:08:45Z
PolicyType	string	Indicates whether this protection policy is the default policy, which is the same as the PolicyType field in the QueryArgs parameter.	default

Examples

Sample success responses

JSONformat

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-2e83-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Policies": [
    {
      "PolicyStatus": "on",
      "DefenseScene": "custom_acl",
      "DomainCount": 22,
      "PolicyName": "policy_test",
      "PolicyId": 100001,
      "RuleCount": 9,
      "GmtModified": "2021-12-29T17:08:45Z",
      "PolicyType": "default"
    }
  ]
}

Error codes

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