调用ModifySecurityIps接口修改RDS实例IP白名单。
添加IP地址到IP白名单内,允许这些IP地址访问该RDS实例。详情请参见设置白名单。
说明 调用该接口时,实例状态必须为运行中,否则将操作失败。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifySecurityIps |
系统规定参数。取值:ModifySecurityIps。 |
DBInstanceId | String | 是 | pgm-bp18n0c8zt45**** |
实例ID。 |
SecurityIps | String | 是 | 10.23.XX.XX |
该实例的IP白名单,多个IP地址请以英文逗号(,)隔开,不可重复。支持如下两种格式:
说明 每个实例最多添加1000个IP或IP段,即所有IP白名单分组内的IP或IP段总和不能超过1000。当IP较多时,建议合并为IP段填入,例如10.23.XX.XX/24。
|
DBInstanceIPArrayName | String | 否 | test |
需要修改的IP白名单分组名称,默认操作“Default”分组。 说明 单个实例最多支持200个白名单分组。
|
DBInstanceIPArrayAttribute | String | 否 | hidden |
白名单分组属性,默认为空。 说明 控制台不显示带有hidden属性的分组,带有该标签的分组通常是用于访问DTS等服务的。
|
SecurityIPType | String | 否 | IPv4 |
IP地址类型。 暂不支持IPv6,取值固定为IPv4。 |
WhitelistNetworkType | String | 否 | Classic |
白名单的网络类型,取值:
默认值:MIX。 说明 在通用白名单模式下会添加IP到通用分组里,在高安全白名单模式下会同时添加IP到经典网络和专有网络分组里。
|
ModifyMode | String | 否 | Cover |
修改方式,取值:
默认值:Cover。 |
FreshWhiteListReadins | String | 否 | pgr-bp17yuz4dn3d****,pgr-bp1vn2ph54u1**** |
表示白名单同步到只读实例清单。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TaskId | String | 115855279 |
任务ID。 |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
请求ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=ModifySecurityIps
&DBInstanceId=pgm-bp18n0c8zt45****
&SecurityIps=10.23.12.24
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifySecurityIpsResponse>
<RequestId> 1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<TaskId>115855279</TaskId>
</ModifySecurityIpsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : " 1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"TaskId" : 115855279
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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列表无效。 |
访问错误中心查看更多错误码。