该接口用于修改RDS实例的IP白名单。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifySecurityIps | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | pgm-bp18n0c8zt45**** |
SecurityIps | string | 是 | 该实例的IP白名单,多个IP地址请以英文逗号(,)隔开,不可重复。支持如下两种格式:
说明
每个实例最多添加1000个IP或IP段,即所有IP白名单分组内的IP或IP段总和不能超过1000。当IP较多时,建议合并为IP段填入,例如10.23.XX.XX/24。
| 10.23.XX.XX |
DBInstanceIPArrayName | string | 否 | 需要修改的IP白名单分组名称,默认操作Default分组。 说明
单个实例最多支持200个白名单分组。
| test |
DBInstanceIPArrayAttribute | string | 否 | 白名单分组属性,默认为空。 说明
控制台不显示带有hidden属性的分组,带有该标签的分组通常是用于访问DTS等服务的。
| hidden |
SecurityIPType | string | 否 | IP地址类型。 暂不支持IPv6,取值固定为IPv4。 | IPv4 |
WhitelistNetworkType | string | 否 | 白名单的网络类型,取值:
默认值:MIX。 说明
在通用白名单模式下会添加IP到通用分组里,在高安全白名单模式下会同时添加IP到经典网络和专有网络分组里。
| Classic |
ModifyMode | string | 否 | 修改方式,取值:
默认值:Cover。 | Cover |
FreshWhiteListReadins | string | 否 | 表示白名单同步到只读实例清单。
| pgr-bp17yuz4dn3d****,pgr-bp1vn2ph54u1**** |
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "11585****",
"RequestId": " 1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectMasterDBInstanceState | Master instance state does not support this operation. | 主实例状态不支持此操作。 |
400 | InvalidWhitelistNetType.Malformed | Specified WhitelistNetType is not valid. | 白名单的网络类型(WhitelistNetworkType)错误,请检查参数正确性。 |
400 | InvalidIPArrayAttribute.Format | The format of the IP attribute is invalid. | DBInstanceIPArrayAttribute参数格式不正确,请修改参数后重试。多个IP地址请以英文逗号(,)隔开,不可重复。支持如下两种格式: IP地址形式,例如:10.23.12.24。 CIDR形式,例如:10.23.12.0/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。 |
400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list. | 指定的安全IP列表无效。其中包含重复值。 |
400 | SecurityIPList.Format | Specified SecurityIPList is not valid. | 指定的安全IP列表无效。 |
403 | IncorrectDBType | The current DB type does not support this operation. | 操作失败,当前数据库类型不支持此操作,请使用其他类型的数据库进行操作。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | IncorrectDBInstanceCharacterType | Current DB Instance character_type does not support this operation. | 当前DB实例字符类型不支持此操作。 |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
403 | IncorrectEngineVersion | The engine version does not support the operation. | 操作失败,当前数据库版本不支持该操作。 |
404 | Readins.NotFound | The current instance does not contain any read only instance. The operation is not supported. | 操作失败,当前实例不存在只读实例。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | 没有找到指定的实例,请检查实例的正确性。 |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败,实例处于锁定状态。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|