调用AddAddressBook添加访问控制地址簿_云防火墙(Cloud Firewall)-阿里云帮助中心

添加安全访问控制地址簿，包括IP地址簿、ECS标签地址簿、端口地址簿和域名地址簿。

接口说明

本接口一般用于添加访问控制的 IP 地址簿、ECS 标签地址簿、端口地址簿或域名地址簿。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:AddAddressBook

create

*AddressBook

acs:yundun-cloudfirewall::{#accountId}:addressbook/*

无

请求参数

名称	类型	必填	描述	示例值
SourceIp `deprecated`	string	否	访问者源 IP 地址。	192.0.XX.XX
Lang	string	否	接收消息的语言类型。 zh（默认）：中文。 en：英文。	zh
AddressList	string	否	地址簿的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。说明当 GroupType 为`ip`、`port`或`domain`时必须设置。当 GroupType 为`ip`时，地址列表中填写 IP 地址。例如：192.0.XX.XX/32 开发网段,10.0.0.X/24,192.0.XX.XX/24 测试网段。当 GroupType 为`port`时，地址列表中填写端口或端口范围。例如：80 HTTP 端口,100/200,3306 数据库端口。当 GroupType 为`domain`时，地址列表中填写域名。例如：example.com 测试域名,aliyundoc.com,www.aliyun.com 阿里云官网。	192.0.XX.XX/32 开发网段,192.0.XX.XX/24 测试网段
Description	string	是	地址簿的描述信息。	sz-001
GroupName	string	是	地址簿的名称。	sz-001
GroupType	string	是	地址簿的类型，可选值包括： ip：IP 地址簿。 domain：域名地址簿。 port：端口地址簿。 tag：ECS 标签地址簿。	ip
AutoAddTagEcs	string	否	是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。 1：表示自动添加。 0（默认）：表示不自动添加。	1
TagRelation	string	否	待匹配的多个 ECS 标签间的关系。 and（默认）：多个标签间为“与”关系，即同时匹配多个标签的 ECS 公网 IP 才会被加入地址簿。 or：多个标签间为“或”关系，即只要匹配一个标签的 ECS 公网 IP 就会被加入地址簿。	and
TagList	array	否	待匹配的标签列表信息。
	object	否	无
TagValue	string	否	待匹配的 ECS 标签值。	1
TagKey	string	否	待匹配的 ECS 标签 Key。	TXY

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object
GroupUuid	string	添加成功后返回的地址簿唯一标识 ID。	f04ac7ce-628b-4cb7-be61-310222b7****
RequestId	string	本次请求的 ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****

示例

正常返回示例

JSON格式

{
  "GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorParametersGroupType	The group type is invalid.	无效的group类型
400	ErrorParametersUid	The aliUid parameter is invalid.	aliUid 不合法
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.	地址簿IP地址错误
400	ErrorDBSelect	An error occurred while querying database.	内部错误：数据库查询错误
400	ErrorAddressCountExceed	The maximum number of addresses is exceeded.	地址簿内地址数量超出上限
400	ErrorAddressGroupExist	The address group already exists.	分组已存在
400	ErrorParamDomain	The parameter Domain is invalid.	地址簿域名地址错误
400	ErrorUUIDNew	The UUID is invalid.	内部错误：UUID错误
400	ErrorAddressGroupCountExceed	The maximum number of address group is exceeded.	地址簿数量超出上限
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.	内部错误：数据库插入错误
400	ErrorRecordLog	An error occurred while updating the operation log.	写日志失败
400	ErrorDBUpdate	internal error: sql updat.	请求错误，数据库更新失败。
400	ErrorParametersTagKey	The tag key is invalid.	无效的tag key
400	ErrorParametersTagList	The tag list is invalid.	无效的tag list
400	ErrorTagCountExceed	The maximum number of tag is exceeded.	tag数量超出上限
400	ErrorParametersTagRelation	The tag relation is invalid.	无效的tag relation
400	ErrorParametersGroupPort	The group port is invalid.	地址簿端口错误
400	ErrorPortCountExceed	The maixmum number of port in the group is exceeded.	地址簿内端口数量超出上限
400	InternalError	The request processing has failed due to some unknown error.	由于某些未知错误，请求处理失败。
500	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.	指定资源的ACK集群连接器不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。