文档中心

云防火墙

地址簿

AddAddressBook - 创建访问控制地址簿

AddAddressBook - 创建访问控制地址簿

添加访问控制地址簿。

请求说明

请求方式：POST

请求地址：https://fw-center.volcengineapi.com/?Action=AddAddressBook&Version=2021-09-06

调试

API Explorer

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
AddressList	Array of String	否	["180...1/32"]	地址簿中的地址列表，具体内容取决于地址簿类型。当AutoUpdateType为Manual且AddressDetailList不为空时生效。当GroupTyp为ip时，填写 IPv4 地址或 CIDRv4 信息；当GroupTyp为ipv6时，填写 IPv6 地址或 CIDRv6 信息；当GroupTyp为port时，填写端口信息，支持单个端口（如 22）或端口范围（如100/200）；当GroupTyp为domain时，填写域名信息。
Description	String	否	用于存储公司内部服务器的IP地址	对地址簿的详细描述信息，用于说明地址簿的用途或其他相关信息。
GroupName	String	是	公司内部服务器IP	地址簿的名称，需要满足以下要求：中文字符、大小写英文字母、- 和 _。最大长度为 64个字符。
GroupType	String	是	ip	地址簿的类型，用于指定地址簿中存储的地址类型。 ip：IPv4 地址； ipv6：IPv6 地址； port：端口信息； domain：域名信息。
CloudFirewallId	String	否	cfw-1234567890abcdef	云防火墙实例的唯一标识符，用于指定地址簿所属的云防火墙实例。
AddressDetailList	Array of AddressStructureReq	否	-	地址列表，携带详细地址信息。当AutoUpdateType为Manual时生效。
AutoUpdateType	String	否	Tag	地址簿的自动更新类型，默认值为 Manual。支持的取值如下所示。 Manual：手动更新； Tag：标签地址簿。有新匹配标签的资产，会自动加入到当前地址簿，当前仅支持互联网边界。
InstanceTypeList	Array of String	否	["EcsInstance","ClbInstance"]	资产类型列表，用于指定地址簿中包含的资产类型。当AutoUpdateType为Tag时生效。支持的取值如下所示。 EcsInstance：云服务器； NetworkInterface：网卡； HaVip：高可用虚拟 IP； Nat：NAT 网关； ClbInstance：负载均衡； AlbInstance：应用型负载均衡； VpnGateway：VPN 网关。
ResourceType	String	否	Eip	标签类型，用于指定地址簿中资源的类型。当AutoUpdateType为Tag时生效。支持的取值如下所示。 Eip：公网 IP； InternetAsset：公网资产。
TagRelation	String	否	And	标签之间的逻辑关系，用于指定多个标签之间的组合方式。当AutoUpdateType为Tag时生效。支持的取值如下所示。 And：与关系，表示所有标签必须同时满足； Or：或关系，表示满足任意一个标签即可。
Tags	Array of TagStructure	否	-	标签列表，用于对地址簿进行分类或标记。每个标签包含键值对。当AutoUpdateType为Tag时生效。

AddressStructureReq

参数	类型	是否必选	示例值	描述
Address	String	是	180...1/32	地址簿中地址的详细信息，具体内容取决于地址簿类型。当GroupTyp为ip时，填写 IPv4 地址或 CIDRv4 信息；当GroupTyp为ipv6时，填写 IPv6 地址或 CIDRv6 信息；当GroupTyp为port时，填写端口信息，支持单个端口（如 22）或端口范围（如100/200）；当GroupTyp为domain时，填写域名信息。
Description	String	否	公司内部服务器 IP 地址	对地址簿中单个地址的详细描述信息，用于说明该地址的具体用途或其他相关信息。

TagStructure

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

返回参数

参数	类型	示例值	描述
GroupUuid	String	f04ac7ce-**---**********	地址簿创建成功后返回的唯一标识符，用于后续对该地址簿进行操作时进行识别。

请求示例

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

有用

无用

无用