DescribeRuleGroups - Web Application Firewall - Alibaba Cloud Documentation Center

Queries regular expression rule groups by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeRuleGroups	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.	waf_cdnsdf3****
SearchType	string	No	The type of the query condition. Valid values: id: queries regular expression rule groups by ID. name: queries regular expression rule groups by name.	name
SearchValue	string	No	The query condition.	test
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	02E9A4B8-90FB-5F41-A049-C82277EB82FB
RuleGroups	array<object>	An array of regular expression rule groups.
	object	The regular expression rule group.
RuleGroupId	long	The ID of the regular expression rule group.	115361
RuleTotalCount	integer	The number of built-in rules in the rule group.	4444
GmtModified	long	The most recent time when the rule group was modified.	1664336364000
RuleGroupName	string	The name of the rule group.	ssssss
IsSubscribe	integer	Indicates whether the automatic update feature is enabled for the rule group. 1: The automatic update feature is enabled for the rule group. 2: The automatic update feature is disabled for the rule group.	1
ParentRuleGroupId	long	The ID of the rule group. 0: The rule group is created from scratch. 1011: The rule group is a strict rule group. 1012: The rule group is a medium rule group. 1013: The rue group is a loose rule group.	1012
TotalCount	long	The total number of entries that are returned.	24

Examples

Sample success responses

JSONformat

{
  "RequestId": "02E9A4B8-90FB-5F41-A049-C82277EB82FB",
  "RuleGroups": [
    {
      "RuleGroupId": 115361,
      "RuleTotalCount": 4444,
      "GmtModified": 1664336364000,
      "RuleGroupName": "ssssss",
      "IsSubscribe": 1,
      "ParentRuleGroupId": 1012
    }
  ],
  "TotalCount": 24
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history