ListAllIpGroups-查询所有地址组--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListAllIpGroups-查询所有地址组

最近更新时间：2024.03.01 16:47:39首次发布时间：2024.02.01 14:25:22

查询当前账号下的地址组列表信息，或者通过规则 ID 查询关联的地址组信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListAllIpGroups&Version=2023-12-25

请求参数

参数	类型	是否必填	示例值	描述
Page	Integer	是	`1`	查询页码，默认为 1。
PageSize	Integer	是	`20`	单页条数，默认为 10。范围为 1～100。
RuleTag	String	否	`92770`	查询的关联规则 ID。可通过和白名单接口获取。
TimeOrderBy	String	是	`DESC`	地址组的排列顺序。升序：ASC 降序：DESC
Ip	String	否	`1.2.3.4`	查询的地址或地址段。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`15`	查询到的符合条件的条目总数。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
CurrentPage	Integer	`1`	当前页面的页码。
Count	Integer	`10`	当前页面显示的条目数量。
IpGroupCount	Integer	`3`	当前地址组数量。
IpGroupQuota	Integer	`600`	实例可以添加的地址组数量上限。
IpLimitQuota	Integer	`1000`	单个地址组可以添加的 IP 数量上限。
IpGroupList	Array of IpGroupList objects	-	地址组列表信息。

IpGroupList

参数	类型	示例值	描述
Name	String	`test`	地址组名称。
IpGroupId	Integer	`4128`	地址组 ID。
IpCount	Integer	`3`	地址组内的 IP 地址数量。
RelatedRules	Array of RelatedRules objects	-	引用该地址组的规则信息。
UpdateTime	String	`2024-01-30T21:00:02+08:00`	地址组更新时间。

RelatedRules

参数	类型	示例值	描述
Host	String	`*.test.com`	规则所关联的防护域名信息。
RuleName	String	`禁止访问`	规则名称。
RuleTag	String	`B000000089801`	规则 ID。
RuleType	String	`Black`	地址组关联的规则类型。 Black：黑名单规则 White：白名单规则

请求示例

POST https://open.volcengineapi.com/?Action=ListAllIpGroups&Version=2023-12-25
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

{
  "Page": 1,
  "PageSize": 10,
  "TimeOrderBy": "DESC"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240130212419A25B8B1A283C5B5B****",
        "Action": "ListAllIpGroups",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 1
        "IpGroupCount": 1,
        "IpGroupQuota": 100,
        "IpLimitQuota": 1000,
        "IpGroupList": [
            {
                "Name": "test",
                "IpGroupId": 4182,
                "IpCount": 3,
                "RelatedRules":[
                        {
                            "Host": "*.test.com"
                            "RuleName": "禁止访问",
                            "RuleTag": "B000000092770",
                            "RuleType": "Black"
                        }
                    ]
                },
                "UpdateTime": "2024-01-30T21:00:02+08:00"
            }
        ]
    }
}