DescribeRuleGroups - 分页查询正则规则组 - Web 应用防火墙

分页查询正则规则组。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeRuleGroups	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_cdnsdf3****
SearchType	string	否	查询类型。取值： id: 表示按照规则组 ID 查询。 name: 表示按照规则组名字查询，支持中英文查询。	name
SearchValue	string	否	设置查询内容。	test
PageNumber	integer	否	分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。	1
PageSize	integer	否	分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。	10
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object	请求结果。
TotalCount	long	返回结果的总数。	24
RequestId	string	请求 ID。	02E9A4B8-90FB-5F41-A049-C82277EB82FB
RuleGroups	array<object>	正则规则组列表。
RuleGroup	object	正则规则组列表。
RuleGroupId	long	规则组的 ID。	115361
RuleTotalCount	integer	内置规则数。	4444
RuleGroupName	string	规则组的名称。	ssssss
IsSubscribe	integer	规则组自动更新状态。 1：表示自动更新。 2：表示不自动更新。	1
GmtModified	long	更新时间。	1664336364000
ParentRuleGroupId	long	规则组继承的规则组 ID。 0：表示不继承，从零创建。 1011：表示严格规则组。 1012：表示中等规则组。 1013：表示宽松规则组。	1012

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史