DescribeAddressBook - 查询访问控制地址簿--云防火墙-火山引擎

文档中心

立即注册

导航

DescribeAddressBook - 查询访问控制地址簿

最近更新时间：2025.05.29 17:45:10首次发布时间：2024.03.28 17:09:33

根据地址簿类型、名称、描述或内容查询访问控制地址簿。

请求说明

请求方式：POST
请求地址：https://fw_center.volcengineapi.com/?Action=DescribeAddressBook&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeAddressBook`	接口名称。当前 API 的名称为 `DescribeAddressBook`。
Version	String	是	`2021-09-06`	接口版本。当前 API 的版本为 `2021-09-06`。

Body

参数	类型	是否必选	示例值	描述
GroupType	String	否	`ip`	地址簿类型，用于精确查询地址簿列表。可选值如下所示。 `ip`：IP地址簿； `port`：端口地址簿； `domain`：域名地址簿。
PageNumber	Integer	否	`1`	分页页码，默认值为`1`。
PageSize	Integer	否	`10`	返回数据的分页大小，表示每页显示的记录数量。
Query	String	否	`180...*`	模糊查询条件，支持对地址簿名称、描述信息或地址列表进行模糊匹配。

返回参数

参数	类型	示例值	描述
Count	Integer	`1`	返回数据的实际数量。当查询数据为空且使用 `Python SDK` 调用时，此项为 `None`。
Data	Array of AddressBookDetail	`--`	地址簿详情。
PageNumber	Integer	`1`	返回数据的分页页码，表示当前查询结果所在的页码。
PageSize	Integer	`10`	返回数据的分页大小，表示每页显示的记录数量。
TotalCount	Integer	`12`	返回数据的总数量。当查询数据为空且使用 `Python SDK` 调用时，此项为 `None`。

AddressBookDetail

参数	类型	示例值	描述
RefCnt	Integer	`20`	地址簿的引用计数，表示该地址簿被引用的次数。
Updated	Integer	`1733831812`	地址簿的最后更新时间戳，以 Unix 时间戳格式表示。
GroupName	String	`AddressBookName`	地址簿的名称，用于标识不同的地址簿。
GroupType	String	`ip`	地址簿的类型，用于区分不同类型的地址簿，具体取值如下所示。 `ip`：IP地址簿； `port`：端口地址簿； `domain`：域名地址簿。
GroupUuid	String	`f04ac7ce-**---**********`	地址簿的唯一标识符，用于在系统中唯一识别该地址簿。
AddressList	Array of String	`["180.1.1.1/32","192.168.1.0/24"]`	地址簿中包含的地址列表，用于存储该地址簿下的所有地址条目。
Description	String	`这是一个用于存储内部服务器IP地址的地址簿。`	地址簿的描述信息，用于提供关于该地址簿的额外说明或备注。

请求示例

POST https://fw_center.volcengineapi.com/?Action=DescribeAddressBook&Version=2021-09-06
{
    "GroupType": "ip",
    "PageNumber": 1,
    "PageSize": 10,
    "Query": "180.*.*.*"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeAddressBook",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Count": 1,
        "Data": [
            {
                "RefCnt": 20,
                "Updated": 1733831812,
                "GroupName": "AddressBookName",
                "GroupType": "ip",
                "GroupUuid": "f04ac7ce-****-****-****-************",
                "AddressList": [
                    "180.*.*.1/32"
                ],
                "Description": "这是一个用于存储内部服务器IP地址的地址簿。"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 12
    }
}

错误码

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