AddAddressBook - 创建访问控制地址簿--云防火墙-火山引擎

文档中心

立即注册

导航

AddAddressBook - 创建访问控制地址簿

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

添加访问控制地址簿。

请求说明

请求方式：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"]`	地址簿中的地址列表，具体内容取决于地址簿类型。当类型为 `ip` 时，填写 `ipv4` 或 `cidrv4` 地址；当类型为 `port` 时，填写端口信息，支持单个端口（如 `22`）或端口范围（如 `100/200`）；当类型为 `domain` 时，填写域名信息。
Description	String	否	`用于存储公司内部服务器的IP地址`	对地址簿的详细描述信息，用于说明地址簿的用途或其他相关信息。
GroupName	String	是	`公司内部服务器IP`	地址簿的名称，需要满足以下要求：中文字符、大小写英文字母、`-` 和 `_`。最大长度为 `64` 个字符。
GroupType	String	是	`ip`	地址簿的类型，用于指定地址簿中存储的地址类型。 `ip`：IP 地址； `port`：端口信息； `domain`：域名信息。

返回参数

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

请求示例

POST https://fw_center.volcengineapi.com/?Action=AddAddressBook&Version=2021-09-06
{
    "AddressList": [
        "192.168.0.1/32",
        "192.168.0.2/32"
    ],
    "CloudFirewallId": "CloudFirewall********",
    "Description": "Description",
    "GroupName": "AddressBookName",
    "GroupType": "ip"
}

返回示例

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

错误码

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