You need to enable JavaScript to run this app.
导航
云防火墙
  • 文档首页
    • /
  • 云防火墙

AddAddressBook - 添加访问控制地址簿

最近更新时间：2024.03.28 17:09:33

首次发布时间：2024.03.28 17:09:33

我的收藏

添加访问控制地址簿。

调试

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

AddAddressBook

要执行的操作，取值：AddAddressBook

Version
String
是

2021-09-06

API的版本，取值：2021-09-06

GroupName
String
是

测试

地址簿名称

GroupType
String
是

ip

地址簿类型：

  • ip - IP地址簿
  • port - 端口地址簿
  • domain - 域名地址簿
AddressList
Array of String
是

["192.168.0.1/32", "192.168.0.2/32"]

地址簿的地址列表：

  • 当GroupType为ip时，地址列表中填写ipv4/cidrv4地址
  • 当GroupType为port时，地址列表中填写端口信息，支持22、100/200两种格式
  • 当GroupType为domain时，地址列表中填写域名信息；
Description
String
否

测试

描述信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
GroupUuid
String

f04ac7ce-628b-4cb7-be61-310222b7****

添加成功后返回的地址簿唯一标识

请求示例

POST /AddAddressBook HTTP/1.1

{
  "GroupName": "TEST-API",
  "GroupType": "ip",
  "AddressList": [
    "192.168.0.1/32",
    "192.168.0.2/32"
  ],
  "Description": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2023*****",
        "Service": "",
        "Region": "",
        "Action": "AddAddressBook",
        "Version": "2021-09-06"
    },
    "Result": {
        "GroupUuid": "00da12f2-*****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
UpdateDbFailed
Update configuration failed

更新配置错误

400
QueryDbFailed
Query configuration failed

查询数据库失败

400
MissingParameter
The required parameter %s is missing.

缺少所需的参数

400
InvalidParameter
Invalid Parameter

无效的参数

400
InvalidParameter.AddressList
The AddressList parameter is invalid

AddressList参数无效

400
Exceed.AddressBookCount
The maximum number of address book is exceeded.

超过了地址簿最大可用数量

400
Duplicate.AddressBookName
The addressBook's names cannot be the same.

地址簿名称不允许重复

500
InternalError
Internal service error. %s

内部服务错误