Queries access control address books by type, name, description, or content.

HTTP request

Request method: POST

Request URL: https://fw-center.volcengineapi.com/?Action=DescribeAddressBook&Version=2021-09-06

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Query

Parameter	Type	Required	Example value	Description
Action	String	Yes	DescribeAddressBook	Interface name. The name of the current API is DescribeAddressBook.
Version	String	Yes	2021-09-06	API version. The current API version is 2021-09-06.

Body

Parameter	Type	Required	Example value	Description
GroupType	String	No	ip	The address book type, used for precise queries of the address book list. The available values are as follows. ip: IPv4 address book ipv6: IPv6 address book port: Port address book domain: Domain name address book
PageNumber	Integer	No	1	The page number. The default value is1。
PageSize	Integer	No	10	The number of records to display on each page.
Query	String	No	180...*	A fuzzy search condition for the address book name, description, or address list.
CloudFirewallId	String	No	CloudFirewall********	The Cloud Firewall instance ID.

Response parameters

Parameters	Type	Example value	Description
Count	Integer	1	The actual number of returned records. When a query returns no data and is called using the Python SDK, this value is None.
Data	Array of AddressBookDetail	--	Address book details.
PageNumber	Integer	1	The page number of the returned data. It indicates the current page of the query results.
PageSize	Integer	10	The number of records displayed per page.
TotalCount	Integer	12	The total number of returned data entries. When a query using the Python SDK returns no data, this field is None.

AddressBookDetail

Parameter	Type	Example value	Description
Tags	Array of TagStructure	-	A list of tags for identifying and classifying address books.
RefCnt	Integer	20	The reference count of the address book, indicating the number of times it is referenced.
Updated	Integer	1733831812	The last update timestamp of the address book, in Unix timestamp format.
GroupName	String	AddressBookName	The name of the address book, which is used to identify different address books.
GroupType	String	ip	The type of the address book. The valid values are as follows. ip: an IPv4 address book ipv6: an IPv6 address book port: a port address book domain: a domain address book
GroupUuid	String	f04ac7ce-**---**********	The unique identifier of the address book.
AddressList	Array of String	["180.1.1.1/32","192.168.1.0/24"]	The list of addresses in the address book, used to store all its address entries. Effective when AutoUpdateType is Manual and AddressDetailList is not empty.
Description	String	An address book for storing internal server IP addresses.	The description of the address book, providing additional information or remarks.
TagRelation	String	And	The logical relationship for combining multiple tags. This takes effect when AutoUpdateType is set to Tag. The supported values are as follows. And: All tags must be matched. Or: At least one tag must be matched.
ResourceType	String	InternetAsset	The type of resource associated with the address book. This takes effect when AutoUpdateType is Tag. The supported values are as follows. Eip: public IP; InternetAsset: Internet asset.
AutoUpdateType	String	Tag	The automatic update type for the address book. The default value is Manual. The supported values are as follows. Manual: Manual update. Tag: a tag address book. Assets with new matching tags are automatically added to the current address book. This feature currently only supports the internet boundary.
InstanceTypeList	Array of String	["EcsInstance","Nat"]	A list of instance types associated with the address book. Takes effect when AutoUpdateType is Tag. The supported values are as follows. EcsInstance: cloud server; NetworkInterface: network interface; HaVip: high-availability virtual IP; Nat: NAT gateway; ClbInstance: load balancer; AlbInstance: application load balancer; VpnGateway: VPN gateway.
AddressDetailList	Array of AddressStructureResp	-	A detailed list of addresses in the address book, including the type, value, and description for each address. Effective when AutoUpdateType is Manual.

TagStructure

Parameter	Type	Example value	Description
Key	String	key	Obtain the tag key from the Tag Key Query API and pass it as the value.
Value	String	value	Retrieve the corresponding tag values using the Query Tag Keys API and pass them as the target value.

AddressStructureResp

Parameter	Type	Sample value	Description
Type	String	port	The address type. The following values are supported. ip: IPv4 address; ipv6: IPv6 address; domain: Domain name; port: Port.
Address	String	22/22	The specific address value. Its format depends on the value of GroupType: When GroupType is ip, the value is an IPv4 address or CIDRv4 information. When GroupType is ipv6, the value is an IPv6 address or CIDRv6 information. When GroupType is port, the value is port information. When GroupType is domain, the value is domain information.
Description	String	Allow SSH access	A description for recording its purpose, remarks, or other related information.

Sample request

Sample response

Error codes

Visit Common error codes for more information.

Cloud Firewall