ModifyAddressBookList-增量修改地址簿的地址列表--云防火墙-火山引擎

文档中心

立即注册

导航

ModifyAddressBookList-增量修改地址簿的地址列表

最近更新时间：2025.09.28 22:49:08首次发布时间：2025.08.11 12:01:35

向指定地址簿添加地址列表或删除其中的地址列表。适用于只需新增或删除部分地址列表的场景。可在现有地址簿基础上，选择添加或删除地址列表，其他信息不受影响。

请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
AddressDetailList	Array of AddressStructureReq	否	`-`	地址列表。
CloudFirewallId	String	否	`CloudFirewall1234567890`	云防火墙实例的唯一标识符，用于指定需要修改地址簿的云防火墙实例。
GroupUuid	String	是	`f04ac7ce-1234-5678-90ab-cdef12345678`	地址簿的唯一标识 ID，用于指定需要修改的地址簿。
ModifyType	String	是	`Add`	指定对地址簿的修改类型。支持的取值如下所示。 `Add`：添加地址； `Remove`：删除地址。

AddressStructureReq

参数类型是否必选示例值描述

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

Address

String

是

180.*.*.1/32

地址簿中地址的详细信息，具体内容取决于地址簿类型。

当GroupTyp为ip时，填写 IPv4 地址或 CIDRv4 信息；
当GroupTyp为ipv6时，填写 IPv6 地址或 CIDRv6 信息；
当GroupTyp为port时，填写端口信息，支持单个端口（如 22）或端口范围（如100/200）；
当GroupTyp为domain时，填写域名信息。

Description String 否 公司内部服务器 IP 地址 对地址簿中单个地址的详细描述信息，用于说明该地址的具体用途或其他相关信息。

返回参数

参数	类型	示例值	描述
GroupUuid	String	`f04ac7ce-1234-5678-90ab-cdef12345678`	地址簿的唯一标识 ID，用于标识修改后的地址簿列表。

请求示例

POST https://fw-center.volcengineapi.com/?Action=ModifyAddressBookList&Version=2021-09-06
{
    "AddressDetailList": [
        {
            "Address": "192.168.1.1/24",
            "Description": "公司内部服务器IP段"
        }
    ],
    "CloudFirewallId": "CloudFirewall****",
    "GroupUuid": "f04ac7ce-****",
    "ModifyType": "Add"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ModifyAddressBookList",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "GroupUuid": "f04ac7ce-****-****-****-************"
    }
}

错误码

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