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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SourceIp	string	否	请求源 ip。无需填写，系统自动获取。	60.208..
Lang	string	否	返回消息的语言类型。取值： zh（默认）：中文 en：英文	zh
PageSize	integer	否	分页查询时，每页的行数。默认值为 10。	10
CurrentPage	integer	否	分页查询时，当前页的页码。默认值为 1。	1
WafLang	string	否	返回消息的语言类型。取值： ZH（默认）：中文 EN：英文	ZH
Type	integer	否	规则组类型。取值：默认空 10：系统规则组 1：自定义规则组	10
PolicyId	long	否	规则组 ID，仅支持单个输入。	1011
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。	waf_cdnsdf3****
Region	string	否	地域 ID。取值： cn：中国大陆地区（默认） cn-hongkong：海外地区	cn
ResourceGroupId	string	否	WAF 实例在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。	rg-aek2**
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 id。	02E9A4B8-90FB-5F41-A049-*
TaskStatus	integer	当前请求的执行状态： 0：等待执行。 1：正在执行中。 2：已执行完成。	2
Total	integer	返回结果的总数。	1
WafTaskId	string	waf 的请求 id。	123
RuleGroups	object []	规则组列表。
Type	integer	规则组类型。取值： 10：系统规则组 1：自定义规则组	1
RuleCnt	integer	当前规则的数量。	1
RuleGroupUpdateTime	long	规则组更新时间，秒级时间戳	1711445265
PolicyId	long	规则组 ID。	116562
Name	string	规则组名称。	rule_group_test
TemplatePolicyId	long	规则组模板	1102
RuleGroupTemplateName	string	规则模板的名称。	rule_group_test
Desc	string	规则组描述。	desc
WafVersion	long	为当前配置设置一个版本号（用于实现乐观锁控制）。	11
DomainList	array	引用当前规则组的域名列表。
	string	引用当前规则组的域名	test.aliyundome.com

示例

正常返回示例

JSON格式

{
  "RequestId": "02E9A4B8-90FB-5F41-A049-*",
  "TaskStatus": 2,
  "Total": 1,
  "WafTaskId": "123",
  "RuleGroups": [
    {
      "Type": 1,
      "RuleCnt": 1,
      "RuleGroupUpdateTime": 1711445265,
      "PolicyId": 116562,
      "Name": "rule_group_test",
      "TemplatePolicyId": 1102,
      "RuleGroupTemplateName": "rule_group_test",
      "Desc": "desc",
      "WafVersion": 11,
      "DomainList": [
        "test.aliyundome.com"
      ]
    }
  ]
}

错误码

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