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

文档中心

立即注册

导航

AddAddressBook - 创建访问控制地址簿

最近更新时间：2024.11.25 17:03:53首次发布时间：2024.03.28 17:09:33

添加访问控制地址簿。

请求说明

请求方式：POST
请求地址：?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`	地址簿的地址列表：当GroupType为ip时，地址列表中填写ipv4/cidrv4地址当GroupType为port时，地址列表中填写端口信息，支持22、100/200两种格式当GroupType为domain时，地址列表中填写域名信息
Description	String	否	`Description`	描述信息。
GroupName	String	是	`AddressBookName`	地址簿名称，支持中文、大小写英文、-、_ ,长度为64字符
GroupType	String	是	`ip`	地址簿类型： ip - IP地址簿 port - 端口地址簿 domain - 域名地址簿

返回参数

参数	类型	示例值	描述
GroupUuid	String	`f04ac7ce-**---**********`	成功后返回地址簿唯一标识ID

请求示例

POST ?Action=AddAddressBook&Version=2021-09-06
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "AddressList": [
    "192.168.0.1/32",
    "192.168.0.2/32"
  ],
    "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-****-****-****-************"
    }
}