文档

AddAddressBook - 添加访问控制地址簿

更新时间:

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

接口说明

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:AddAddressBookWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SourceIpdeprecatedstring

访问者源 IP 地址。

192.0.XX.XX
Langstring

接收消息的语言类型。

  • zh(默认):中文。
  • en:英文。
zh
AddressListstring

地址簿的地址列表,多个地址间用英文逗号分隔。

说明 当 GroupType 为ipportdomain时必须设置。
  • 当 GroupType 为ip时,地址列表中填写 IP 地址。例如:192.0.XX.XX/32, 192.0.XX.XX/24。

  • 当 GroupType 为port时,地址列表中填写端口或端口范围。例如:80, 100/200。

  • 当 GroupType 为domain时,地址列表中填写域名。例如:example.com, aliyundoc.com。

192.0.XX.XX/32, 192.0.XX.XX/24
Descriptionstring

地址簿的描述信息。

sz-001
GroupNamestring

地址簿的名称。

sz-001
GroupTypestring

地址簿的类型,可选值包括:

  • ip:IP 地址簿。

  • domain:域名地址簿。

  • port:端口地址簿。

  • tag:ECS 标签地址簿。

ip
AutoAddTagEcsstring

是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。

  • 1:表示自动添加。

  • 0(默认):表示不自动添加。

1
TagRelationstring

待匹配的多个 ECS 标签间的关系。

  • and(默认):多个标签间为“与”关系,即同时匹配多个标签的 ECS 公网 IP 才会被加入地址簿。

  • or:多个标签间为“或”关系,即只要匹配一个标签的 ECS 公网 IP 就会被加入地址簿。

and
TagListobject []

待匹配的标签列表信息。

TagValuestring

待匹配的 ECS 标签值。

1
TagKeystring

待匹配的 ECS 标签 Key。

TXY

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

返回参数

名称类型描述示例值
object
GroupUuidstring

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

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

本次请求的 ID。

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ErrorParametersGroupTypeThe group type is invalid.无效的group类型
400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
400ErrorParametersGroupAddressThe IP address of the address group is invalid.地址簿IP地址错误
400ErrorDBSelectAn error occurred while querying database.内部错误:数据库查询错误
400ErrorAddressCountExceedThe maximum number of addresses is exceeded.地址簿内地址数量超出上限
400ErrorAddressGroupExistThe address group already exists.分组已存在
400ErrorParamDomainThe parameter Domain is invalid.地址簿域名地址错误
400ErrorUUIDNewThe UUID is invalid.内部错误:UUID错误
400ErrorAddressGroupCountExceedThe maximum number of address group is exceeded.地址簿数量超出上限
400ErrorDBInsertAn error occurred while performing an insert operation in the database.内部错误:数据库插入错误
400ErrorRecordLogAn error occurred while updating the operation log.写日志失败

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈