AddAddressBook_云防火墙_API文档-阿里云OpenAPI开发者门户

接口说明

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

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

请求速率为9/1(s)。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

yundun-cloudfirewall:AddAddressBook	Create	AddressBook acs:yundun-cloudfirewall::{#accountId}:addressbook/*	无	无

字段名称	字段详情
deprecatedSourceIpstring	访问者源 IP 地址。示例值:192.0.XX.XX
Langstring	接收消息的语言类型。展开详情示例值:zh
AddressListstring	地址簿的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。展开详情示例值:192.0.XX.XX/32 开发网段,192.0.XX.XX/24 测试网段参考取值来源: DescribeAddressBook
Descriptionstring	地址簿的描述信息。示例值:sz-001字符长度 <= 256字符长度 >= 2
GroupNamestring	地址簿的名称。示例值:sz-001字符长度 <= 128字符长度 >= 2
GroupTypestring	地址簿的类型，可选值包括：展开详情示例值:ip
AutoAddTagEcsstring	是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。展开详情示例值:1
TagRelationstring	待匹配的多个 ECS 标签间的关系。展开详情示例值:and
TagListarray<object>	待匹配的标签列表信息。子级条数 <= 100

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

字段名称	字段详情
GroupUuidstring	添加成功后返回的地址簿唯一标识 ID。示例值:f04ac7ce-628b-4cb7-be61-310222b7****
RequestIdstring	本次请求的 ID。示例值:CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****

没有我想要的错误码, 点击反馈

HTTP 状态码	错误码	错误信息	操作

400	ErrorParametersGroupType	The group type is invalid.	诊断
400	ErrorParametersUid	The aliUid parameter is invalid.	诊断
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.	诊断
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.	诊断
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.	诊断
400	ErrorParametersTagList	The tag list is invalid.	诊断
400	ErrorTagCountExceed	The maximum number of tag is exceeded.	诊断
400	ErrorParametersTagRelation	The tag relation is invalid.	诊断
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.	诊断
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.	诊断
500	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.	诊断

	变更时间	变更内容概要	操作
	2025-02-20	变更错误码400
	2025-01-16	变更请求参数AddressList 变更请求参数Description 变更请求参数GroupName
	2024-12-30	新增错误码404 新增错误码500