文档中心

云防火墙

地址簿

DescribeAddressBook - 查询访问控制地址簿

DescribeAddressBook - 查询访问控制地址簿

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

请求说明

请求方式：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：IPv4 地址簿 ipv6：IPv6 地址簿 port：端口地址簿 domain：域名地址簿
PageNumber	Integer	否	1	分页页码，默认值为1。
PageSize	Integer	否	10	返回数据的分页大小，表示每页显示的记录数量。
Query	String	否	180...*	模糊查询条件，支持对地址簿名称、描述信息或地址列表进行模糊匹配。
CloudFirewallId	String	否	CloudFirewall********	云防火墙实例 ID。

返回参数

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

AddressBookDetail

参数	类型	示例值	描述
Tags	Array of TagStructure	-	地址簿的标签列表，用于标识和分类地址簿。
RefCnt	Integer	20	地址簿的引用计数，表示该地址簿被引用的次数。
Updated	Integer	1733831812	地址簿的最后更新时间戳，以 Unix 时间戳格式表示。
GroupName	String	AddressBookName	地址簿的名称，用于标识不同的地址簿。
GroupType	String	ip	地址簿的类型，用于区分不同类型的地址簿，具体取值如下所示。 ip：IPv4 地址簿 ipv6：IPv6 地址簿 port：端口地址簿 domain：域名地址簿
GroupUuid	String	f04ac7ce-**---**********	地址簿的唯一标识符，用于在系统中唯一识别该地址簿。
AddressList	Array of String	["180.1.1.1/32","192.168.1.0/24"]	地址簿中包含的地址列表，用于存储该地址簿下的所有地址条目。当AutoUpdateType为Manual且AddressDetailList不为空时生效。
Description	String	这是一个用于存储内部服务器IP地址的地址簿。	地址簿的描述信息，用于提供关于该地址簿的额外说明或备注。
TagRelation	String	And	标签的逻辑关系，用于指定多个标签之间的组合方式。当AutoUpdateType为Tag时生效。支持的取值如下所示。 And：与关系，表示所有标签必须同时满足； Or：或关系，表示满足任意一个标签即可。
ResourceType	String	InternetAsset	资源类型，用于标识地址簿关联的资源类型。当AutoUpdateType为Tag时生效。支持的取值如下所示。 Eip：公网 IP； InternetAsset：公网资产。
AutoUpdateType	String	Tag	地址簿的自动更新类型，默认值为 Manual。支持的取值如下所示。 Manual：手动更新； Tag：标签地址簿。有新匹配标签的资产，会自动加入到当前地址簿，当前仅支持互联网边界。
InstanceTypeList	Array of String	["EcsInstance","Nat"]	实例类型列表，用于标识地址簿关联的实例类型。当AutoUpdateType为Tag时生效。支持的取值如下所示。 EcsInstance：云服务器； NetworkInterface：网卡； HaVip：高可用虚拟 IP； Nat：NAT 网关； ClbInstance：负载均衡； AlbInstance：应用型负载均衡； VpnGateway：VPN 网关。
AddressDetailList	Array of AddressStructureResp	-	地址簿中地址的详细信息列表，包含每个地址的类型、具体值和描述信息。当AutoUpdateType为Manual时生效。

TagStructure

参数	类型	示例值	描述
Key	String	key	根据标签键查询接口获取标签键信息并传入目标值。
Value	String	value	根据标签键查询接口获取标签键对应的标签值信息并传入目标值。

AddressStructureResp

参数	类型	示例值	描述
Type	String	port	地址类型，支持的取值如下所示。 ip：IPv4 地址； ipv6：IPv6 地址； domain：域名； port：端口。
Address	String	22/22	具体地址值，其格式取决于 GroupType 的取值：当GroupTyp为ip时，对应 IPv4 地址或 CIDRv4 信息；当GroupTyp为ipv6时，对应 IPv6 地址或 CIDRv6 信息；当GroupTyp为port时，对应端口信息；当GroupTyp为domain时，对应域名信息。
Description	String	允许 SSH 访问	描述信息，用于记录相关用途、备注或其他相关信息。

请求示例

返回示例

错误码

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

最近更新时间：2025.08.11 12:01:32

这个页面对您有帮助吗？

有用

有用

无用

无用