修改地址簿。
接口说明
本接口一般用于修改地址簿。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-cloudfirewall:ModifyAddressBook |
update |
*AddressBook
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
SourceIp
deprecated
|
string |
否 |
访问者源 IP 地址。 |
192.0.XX.XX |
| Lang |
string |
否 |
语言类型。 枚举值：
|
zh |
| AddressList |
string |
否 |
地址簿中的地址列表，多个地址间用英文逗号分隔，一个地址元素用空格分隔地址和描述。当 GroupType 为 ip、port 或 domain 时，您必须配置此参数。
|
192.0.XX.XX/32 ,192.0.XX.XX/24 |
| Description |
string |
是 |
地址簿的描述信息。 |
bj-001 |
| GroupName |
string |
是 |
地址簿的名称。 |
bj-001 |
| GroupUuid |
string |
是 |
地址簿的唯一标识 ID。 说明
取值来源：批量查询地址簿列表。 |
0657ab9d-fe8b-4174-b2a6-6baf358e**** |
| AutoAddTagEcs |
string |
否 |
是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。 枚举值：
|
1 |
| TagRelation |
string |
否 |
多个 ECS 标签间的关系。 枚举值：
|
and |
| TagList |
array<object> |
否 |
ECS 标签列表。 |
|
|
object |
否 |
ECS 标签。 |
||
| TagValue |
string |
否 |
ECS 标签值。 |
1 |
| TagKey |
string |
否 |
ECS 标签键。 |
TXY |
| ModifyMode |
string |
否 |
修改方式。 说明
当 GroupType 为 ip、ipv6、port 或 domain 时，不配置该参数时，默认采用 Cover 方式修改地址簿。 重要 当 GroupType 为 tag 时，该参数必须为空。 枚举值：
|
Cover |
| AckNamespaces |
array |
否 |
ACK 集群容器组命名空间列表。 说明
数量最多 10 个。 |
|
|
string |
否 |
ACK 集群容器组命名空间。取值来源：
说明
当 GroupType 为 ackNamespace 时，必填。 |
default |
|
| AckLabels |
array<object> |
否 |
ACK 集群容器组标签列表。 说明
数量最多 10 个。 |
|
|
object |
否 |
ACK 集群容器组标签。取值来源：
说明
当 GroupType 为 ackLabel 时，必填。 |
||
| Key |
string |
否 |
ACK 集群容器组标签的键。 |
app |
| Value |
string |
否 |
ACK 集群容器组标签的值。 |
storage-operator |
| AssetMemberUids |
array |
否 |
资产地址簿，成员账号列表。 |
|
|
integer |
否 |
成员账号列表。 |
13580xxxxxx6271 |
|
| AssetRegionResourceTypes |
array<object> |
否 |
资产地址簿，地域和资源类型列表。 |
|
|
array<object> |
否 |
地域和资源类型列表。 |
||
| AssetRegionId |
string |
否 |
资产地域 ID。 枚举值：
|
all |
| ResourceType |
object |
否 |
资产类型。 |
|
| Ipv4 |
object |
否 |
IPv4 资产类型。 |
|
| SlbEIP |
boolean |
否 |
资产类型：SlbEIP。 枚举值：
|
true |
| NatPublicIP |
boolean |
否 |
资产类型：NatPublicIP。 枚举值：
|
false |
| BastionHostIngressIP |
boolean |
否 |
资产类型：BastionHostIngressIP。 枚举值：
|
false |
| EniEIP |
boolean |
否 |
资产类型：EniEIP。 枚举值：
|
false |
| NlbEIP |
boolean |
否 |
资产类型：NlbEIP。 枚举值：
|
false |
| ApiGatewayEIP |
boolean |
否 |
资产类型：ApigEIP。 枚举值：
|
false |
| EcsPublicIP |
boolean |
否 |
资产类型：EcsPublicIP。 枚举值：
|
false |
| BastionHostIP |
boolean |
否 |
资产类型：BastionHostIP。 枚举值：
|
false |
| BastionHostEgressIP |
boolean |
否 |
资产类型：BastionHostEgressIP。 枚举值：
|
false |
| AlbEIP |
boolean |
否 |
资产类型：AlbEIP。 枚举值：
|
false |
| GaEIP |
boolean |
否 |
资产类型：GaEIP。 枚举值：
|
false |
| AiGatewayEIP |
boolean |
否 |
资产类型：AIGatewayEIP。 枚举值：
|
false |
| EIP |
boolean |
否 |
资产类型：EIP。 枚举值：
|
false |
| NatEIP |
boolean |
否 |
资产类型：NatEIP。 枚举值：
|
false |
| SlbPublicIP |
boolean |
否 |
资产类型：SlbPublicIP。 枚举值：
|
false |
| EcsEIP |
boolean |
否 |
资产类型：EcsEIP。 枚举值：
|
false |
| HAVIP |
boolean |
否 |
资产类型：HAVIP。 枚举值：
|
false |
| Ipv6 |
object |
否 |
IPv6 资产类型。 |
|
| SlbIPv6 |
boolean |
否 |
资产类型：SlbIPv6。 枚举值：
|
false |
| NlbIPv6 |
boolean |
否 |
资产类型：NlbIPv6。 枚举值：
|
false |
| EniEIPv6 |
boolean |
否 |
资产类型：EniEIPv6。 枚举值：
|
false |
| AlbIPv6 |
boolean |
否 |
资产类型：AlbIPv6。 枚举值：
|
false |
| GaEIPv6 |
boolean |
否 |
资产类型：GaEIPv6。 枚举值：
|
false |
| AiGatewayEIPv6 |
boolean |
否 |
资产类型：AIGatewayEIPv6。 枚举值：
|
false |
| EcsIPv6 |
boolean |
否 |
资产类型：EcsIPv6。 枚举值：
|
false |
| ApiGatewayEIPv6 |
boolean |
否 |
资产类型：ApigEIPv6。 枚举值：
|
false |
调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。 调用 API 的请求格式，请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
本次请求的 ID。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D |
示例
正常返回示例
JSON格式
{
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
| 400 | ErrorDBSelect | An error occurred while querying database. | 内部错误：数据库查询错误 |
| 400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿内地址数量超出上限 |
| 400 | ErrorParametersGroupAddress | The IP address of the address group is invalid. | 地址簿IP地址错误 |
| 400 | ErrorParamDomain | The parameter Domain is invalid. | 地址簿域名地址错误 |
| 400 | ErrorAddressGroupNotExist | The address group does not exist. | 地址簿不存在 |
| 400 | ErrorDBInsert | An error occurred while performing an insert operation in the database. | 内部错误：数据库插入错误 |
| 400 | ErrorRecordLog | An error occurred while updating the operation log. | 写日志失败 |
| 400 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口错误 |
| 400 | ErrorAclExtendedCountExceed | ACL or extended ACL rules are not matched. | ACL或扩展ACL规格超出限制 |
| 400 | ErrorDBDelete | An error occurred while deleting the database. | 内部错误：数据库删除错误 |
| 400 | ErrorAddressGroupExist | The address group already exists. | 分组已存在 |
| 400 | ErrorAclDomainAnyCountExceed | The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications. | 域名解析数量超过200，应用http|https|smtp|smtps|ssl支持更多配置 |
| 400 | ErrorParametersAddressGroupAddressNotFound | The address to be deleted does not exist in the address book. | 地址簿中不存在需要删除的地址。 |
| 400 | InvalidParameter.AddressBook.AddressDuplicate | The address book address %s is already exist. | 地址簿中的地址%s已存在。 |
| 400 | ErrorAckClusterConnectorBusy | The ACK cluster connector is operating. | 指定的ACK集群连接器正在操作中。 |
| 400 | ErrorParameters | Parameters error. | 参数错误。 |
| 400 | ErrorParametersMemberUidMismatch | The memberUid mismatch the aliUid. | 成员账号和aliUid不匹配。 |
| 401 | ErrorAuthentication | An authentication error occurred. | 认证失败 |
| 404 | ErrorAckClusterConnectorNotFound | The specified resource ACK cluster connector is not found. | 指定资源的ACK集群连接器不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。