调用ModifyDBClusterAccessWhiteList接口修改集群白名单。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyDBClusterAccessWhiteList

系统规定参数，取值：

ModifyDbClusterAccessWhiteList。
DBClusterId String 是 rm-uf6wjk5xxxxxxxxxx

实例ID。
SecurityIps String 是 10.23.12.24

集群的IP白名单，多个IP地址之间以英文逗号（,）隔开，不可重复，最多500个。支持如下两种格式：

  • IP地址形式，例如：10.23.12.24。
  • CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。

ModifyMode值为Delete时，此参数值可以是空，其他情况下必须有非空值。
DBClusterIPArrayName String 否 test

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

IP白名单分组名称以小写字母开头、以数字或小写字母结尾，可包含小写字母、数字及’_’，长度为2~32。

单个实例最多支持50个白名单分组。
DBClusterIPArrayAttribute String 否 hidden

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

控制台不显示带有“hidden”属性的分组，带有该标签的分组通常是用于访问DTS、DRDS服务的。
ModifyMode String 否 Cover

修改白名单的方式。取值：

  • Cover：覆盖原IP白名单；
  • Append：追加IP；
  • Delete：删除IP。

默认值：Cover。

返回数据

名称 类型 示例值 描述
DBClusterId String rm-uf6wjk5xxxxxxxxxx

实例ID。
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

请求ID。
TaskId Integer 1564657730

任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyDBClusterAccessWhiteList
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&SecurityIps=10.23.12.24
&<公共请求参数>

正常返回示例

XML 格式 

<TaskId>1564657730</TaskId>
<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
<DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>

JSON 格式 

{
    "TaskId": 1564657730,
    "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
    "DBClusterId": "rm-uf6wjk5xxxxxxxxxx"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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