修改地址簿。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cloudfirewall:ModifyAddressBook | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIpdeprecated | 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。 说明
修改访问控制策略中设置的地址簿信息,需要提供该地址簿的唯一标识 ID,该 ID 可调用 DescribeAddressBook 接口查询。
| 0657ab9d-fe8b-4174-b2a6-6baf358e**** |
AutoAddTagEcs | string | 否 | 是否自动添加新匹配标签的 ECS 公网 IP 到地址簿。取值:
| 1 |
TagRelation | string | 否 | 多个 ECS 标签间的关系。取值:
| and |
TagList | array<object> | 否 | 待匹配的标签列表。 | |
object | 否 | 无 | ||
TagValue | string | 否 | 待匹配的 ECS 标签值。 | 1 |
TagKey | string | 否 | 待匹配的 ECS 标签 Key。 | TXY |
ModifyMode | string | 否 | 修改方式,取值说明:
说明
当 GroupType 为 ip、ipv6、port 或 domain 时,不配置该参数时,默认采用 Cover 方式修改地址簿。
注意 当 GroupType 为 tag 时,该参数必须为空。 | Cover |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。 调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
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支持更多配置 |
401 | ErrorAuthentication | An authentication error occurred. | 认证失败 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-05 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2024-08-07 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |