DescribeRuleGroups - 分页查询正则规则组

更新时间:2025-01-21 10:06:35

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
yundun-waf:DescribeRuleGroupsget
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
SourceIpstring

请求源 ip。无需填写,系统自动获取。

60.208.*.*
Langstring

返回消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
zh
PageSizeinteger

分页查询时,每页的行数。默认值为 10

10
CurrentPageinteger

分页查询时,当前页的页码。默认值为 1

1
WafLangstring

返回消息的语言类型。取值:

  • ZH(默认):中文
  • EN:英文
ZH
Typeinteger

规则组类型。取值:

  • 默认空
  • 10:系统规则组
  • 1:自定义规则组
10
PolicyIdlong

规则组 ID,仅支持单个输入。

1011
InstanceIdstring

WAF 实例的 ID。

说明
您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
waf_cdnsdf3****
Regionstring

地域 ID。取值:

  • cn:中国大陆地区(默认)
  • cn-hongkong:海外地区
cn
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-aek2**
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

返回参数

名称类型描述示例值
名称类型描述示例值
object
RequestIdstring

请求 id。

02E9A4B8-90FB-5F41-A049-*
TaskStatusinteger

当前请求的执行状态:

  • 0:等待执行。
  • 1:正在执行中。
  • 2:已执行完成。
2
Totalinteger

返回结果的总数。

1
WafTaskIdstring

waf 的请求 id。

123
RuleGroupsarray<object>

规则组列表。

RuleGroupsobject

规则组列表。

Typeinteger

规则组类型。取值:

  • 10:系统规则组
  • 1:自定义规则组
1
RuleCntinteger

当前规则的数量。

1
RuleGroupUpdateTimelong

规则组更新时间,秒级时间戳

1711445265
PolicyIdlong

规则组 ID。

116562
Namestring

规则组名称。

rule_group_test
TemplatePolicyIdlong

规则组模板

1102
RuleGroupTemplateNamestring

规则模板的名称。

rule_group_test
Descstring

规则组描述。

desc
WafVersionlong

为当前配置设置一个版本号(用于实现乐观锁控制)。

11
DomainListarray

引用当前规则组的域名列表。

Domainstring

引用当前规则组的域名

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"
      ]
    }
  ]
}

错误码

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等