首页 云数据库 RDS 开发参考 API参考 API目录 安全加密 ModifySecurityIps - 修改RDS实例IP白名单

ModifySecurityIps - 修改RDS实例IP白名单

更新时间: 2023-11-30 12:14:07

该接口用于修改RDS实例的IP白名单。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

调试

授权信息

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

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

请求参数

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

实例ID。可调用DescribeDBInstances获取。

pgm-bp18n0c8zt45****
SecurityIpsstring

该实例的IP白名单,多个IP地址请以英文逗号(,)隔开,不可重复。支持如下两种格式:

  • IP地址形式,例如:10.23.XX.XX。
  • CIDR形式,例如:10.23.XX.XX/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
说明 每个实例最多添加1000个IP或IP段,即所有IP白名单分组内的IP或IP段总和不能超过1000。当IP较多时,建议合并为IP段填入,例如10.23.XX.XX/24。
10.23.XX.XX
DBInstanceIPArrayNamestring

需要修改的IP白名单分组名称,默认操作Default分组。

说明 单个实例最多支持200个白名单分组。
test
DBInstanceIPArrayAttributestring

白名单分组属性,默认为空。

说明 控制台不显示带有hidden属性的分组,带有该标签的分组通常是用于访问DTS等服务的。
hidden
SecurityIPTypestring

IP地址类型。 暂不支持IPv6,取值固定为IPv4。

IPv4
WhitelistNetworkTypestring

白名单的网络类型,取值:

  • Classic:高安全白名单模式下的经典网络
  • VPC:高安全白名单模式下的专有网络
  • MIX:通用模式

默认值:MIX

说明 在通用白名单模式下会添加IP到通用分组里,在高安全白名单模式下会同时添加IP到经典网络和专有网络分组里。
Classic
ModifyModestring

修改方式,取值:

  • Cover:使用SecurityIps参数的值覆盖原IP白名单。
  • Append:在原IP白名单中增加SecurityIps参数中输入的IP地址。
  • Delete:在原IP白名单中删除SecurityIps参数中输入的IP地址。至少需要保留一个IP地址。

默认值:Cover

Cover
FreshWhiteListReadinsstring

表示白名单同步到只读实例清单。

  • 该参数仅适用于RDS PostgreSQL实例。
  • 如果当前实例包含只读实例,可以通过此参数配置白名单同步,将主实例的白名单同步至指定的只读实例。当有多个只读实例时,用逗号(,)分隔。
  • 如果当前实例没有只读实例,此参数为空。
pgr-bp17yuz4dn3d****,pgr-bp1vn2ph54u1****

返回参数

名称类型描述示例值
object

返回参数详情。

TaskIdstring

任务ID。

11585****
RequestIdstring

请求ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF

示例

正常返回示例

JSON格式

{
  "TaskId": "11585****",
  "RequestId": " 1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectMasterDBInstanceStateMaster instance state does not support this operation.主实例状态不支持此操作。
400InvalidWhitelistNetType.MalformedSpecified WhitelistNetType is not valid.白名单的网络类型(WhitelistNetworkType)错误,请检查参数正确性。
400InvalidIPArrayAttribute.FormatThe format of the IP attribute is invalid.DBInstanceIPArrayAttribute参数格式不正确,请修改参数后重试。多个IP地址请以英文逗号(,)隔开,不可重复。支持如下两种格式: IP地址形式,例如:10.23.12.24。 CIDR形式,例如:10.23.12.0/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the list.指定的安全IP列表无效。其中包含重复值。
400SecurityIPList.FormatSpecified SecurityIPList is not valid.指定的安全IP列表无效。
403IncorrectDBTypeThe current DB type does not support this operation.操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectEngineVersionThe engine version does not support the operation.操作失败,当前数据库版本不支持该操作。
404Readins.NotFoundThe current instance does not contain any read only instance. The operation is not supported.操作失败,当前实例不存在只读实例。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。

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

变更历史

变更时间变更内容概要操作
2022-10-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    新增错误码:403
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
阿里云首页 云数据库 RDS 相关技术圈