DescribeRuleGroups - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a paginated list of regular expression rule groups.

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

yundun-waf:DescribeRuleGroups

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of the WAF instance.	waf_cdnsdf3****
SearchType	string	No	The query type. Valid values: id: Queries by rule group ID. name: Queries by rule group name. Both Chinese and English names are supported.	name
SearchValue	string	No	The content to query.	test
PageNumber	integer	No	The page number of the results to return. The default value is 1, which returns the first page of results.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 10.	10
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	24
RequestId	string	The request ID.	02E9A4B8-90FB-5F41-A049-C82277EB82FB
RuleGroups	array<object>	The list of regular expression rule groups.
	object	The list of regular expression rule groups.
RuleGroupId	integer	The ID of the rule group.	115361
RuleTotalCount	integer	The number of built-in rules.	4444
RuleGroupName	string	The name of the rule group.	ssssss
IsSubscribe	integer	The automatic update status of the rule group. 1: Automatic updates are enabled. 2: Automatic updates are disabled.	1
GmtModified	integer	The time when the rule group was last updated.	1664336364000
ParentRuleGroupId	integer	The ID of the rule group that the current rule group inherits. 0: The rule group is created from scratch and does not inherit from another rule group. 1011: The Strict rule group. 1012: The Medium rule group. 1013: The Loose rule group.	1012

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.