全部产品
Search
文档中心

Web 应用防火墙:DescribeDefenseResourceGroups - 分页查询防护对象组

更新时间:Nov 15, 2024

分页查询防护对象组。

调试

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

授权信息

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

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

请求参数

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

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_v2_public_cn-wwo36****0i
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfmxc7lf****eq
GroupNameLikestring

要查询的防护对象组名称。您可以设置该参数,模糊查询已创建的防护对象组。

demoGroupName
PageNumberinteger

分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。

1
PageSizeinteger

分页查询时,每页包含多少条结果。默认值为 20,表示每页包含 20 条结果。

20
GroupNamesstring

要查询的多个防护对象组。您可以设置该参数,查询多个已创建的防护对象组,多个防护对象组之间使用英文逗号(,)分隔。

groupName1,groupName2
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

BFEC5C77-049B-5E88-A5B6-CB0C****B66E
TotalCountlong

返回结果的总数。

10
Groupsarray<object>

防护对象组列表。

Groupobject

防护对象组。

Descriptionstring

防护对象组描述信息。

This is test description
GmtCreatelong

防护对象组的创建时间。单位:毫秒。

1624343180000
GmtModifiedlong

防护对象组的修改时间。单位:毫秒。

1701656305000
GroupNamestring

防护对象组名称。

apptest
ResourceListstring

防护对象组加入的防护对象名称集合,多个防护对象之间使用英文逗号(,)分隔。

example02.aliyun-waf,example01.aliyun-waf

示例

正常返回示例

JSON格式

{
  "RequestId": "BFEC5C77-049B-5E88-A5B6-CB0C****B66E",
  "TotalCount": 10,
  "Groups": [
    {
      "Description": "This is test description",
      "GmtCreate": 1624343180000,
      "GmtModified": 1701656305000,
      "GroupName": "apptest",
      "ResourceList": "example02.aliyun-waf,example01.aliyun-waf"
    }
  ]
}

错误码

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