文档中心

Web应用防火墙

地址组管理

ListAllIpGroups - 查询所有地址组

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

请求说明

请求方式：POST

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListAllIpGroups

接口名称。当前 API 的名称为 ListAllIpGroups。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

Page Integer 可选示例值：1

查询页码，默认为 1。

ProjectName String 可选示例值：default

资源所属项目名称。获取方式可参考ListProjectResources - 获取项目资源列表。

PageSize Integer 可选示例值：20

单页条数，默认为 10。范围为 1～100。

RuleTag String 可选示例值：92770

查询的关联规则 ID。可通过和白名单接口获取。

TimeOrderBy String 必选示例值：DESC

地址组的排列顺序。

升序：ASC

降序：DESC

Ip String 可选示例值：1.2.**.**

查询的地址或地址段。

返回参数

CurrentPage Integer 可选示例值：2

当前页面的页码。

PageSize Integer 可选示例值：20

单个页面显示的条目数量上限。

TotalCount Integer 可选示例值：25

查询到的符合条件的条目总数。

Count Integer 可选示例值：5

当前页面显示的条目数量。

IpGroupCount Integer 可选示例值：3

当前地址组数量。

IpGroupQuota Integer 可选示例值：600

实例可以添加的地址组数量上限。

IpLimitQuota Integer 可选示例值：1000

单个地址组可以添加的 IP 数量上限。

IpGroupList Object[] 可选示例值：--

地址组列表信息。

Name String 可选示例值：test

地址组名称。

IpGroupId Integer 可选示例值：4128

地址组 ID。

IpCount Integer 可选示例值：3

地址组内的 IP 地址数量。

UpdateTime String 可选示例值：2024-01-07T18:46:09+08:00

地址组更新时间。

RelatedRules Object[] 可选示例值：--

引用该地址组的规则信息。

RuleName String 可选示例值：block_rule

规则名称。

RuleTag String 可选示例值：F00000000****

规则 ID。

RuleType String 可选示例值：Block

地址组关联的规则类型。

Black：黑名单规则

White：白名单规则

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=ListAllIpGroups&Version=2023-12-25

{
    "Page": 1,
    "ProjectName": "default",
    "PageSize": 20,
    "RuleTag": "92770",
    "TimeOrderBy": "DESC",
    "Ip": "1.2.**.**"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListAllIpGroups",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "CurrentPage": 2,
        "PageSize": 20,
        "TotalCount": 25,
        "Count": 5,
        "IpGroupCount": 3,
        "IpGroupQuota": 600,
        "IpLimitQuota": 1000,
        "IpGroupList": [
            {
                "Name": "test",
                "IpCount": 3,
                "IpGroupId": 4128,
                "UpdateTime": "2024-01-07T18:46:09+08:00",
                "RelatedRules": [
                    {
                        "RuleTag": "F00000000****",
                        "RuleName": "block_rule",
                        "RuleType": "Block"
                    }
                ]
            }
        ]
    }
}

最近更新时间：2026.01.20 15:17:10

这个页面对您有帮助吗？

有用

无用