该接口用于创建或修改PolarDB集群的白名单(包括IP白名单和安全组)。

调试

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

请求参数

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

系统规定参数,取值:ModifyDBClusterAccessWhitelist

DBClusterId String pc-xxxxxxxxx

集群ID。

WhiteListType String IP

白名单类型。取值:

  • IP:IP白名单分组。
  • SecurityGroup:安全组。

默认为:IP

DBClusterIPArrayName String default

IP白名单分组的名称。长度为2~120个字符;由小写字母和数字组成;以字母开头,以字母或数字结尾。

  • 如果传入的白名单分组名称不存在,则会创建白名单分组。
  • 如果传入的白名单分组名称已存在,则会修改该白名单分组。
  • 不传入则修改default分组。
说明
  • 1个集群最多支持50个IP白名单分组。
  • WhiteListType取值为IP时本参数才可用。
DBClusterIPArrayAttribute String hidden

IP白名单分组属性。设置为hidden后控制台不可见。

说明
  • 已在控制台显示的IP白名单分组不支持隐藏。
  • WhiteListType取值为IP时本参数才可用。
SecurityIps String 127.0.0.1

IP白名单分组中的IP地址或地址段。所有IP白名单分组累积支持1000个IP地址或地址段,多个IP间用英文逗号(,)隔开,支持以下两种格式:

  • IP地址形式,例如:10.23.12.24。
  • CIDR形式,例如:10.23.12.24/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
说明WhiteListType取值为IP时生效。
ModifyMode String Cover

IP白名单的修改方式,取值如下:

  • Cover:覆盖原IP白名单(默认值)。
  • Append:追加IP。
  • Delete:删除IP。
说明WhiteListType取值为IP时生效。
SecurityGroupIds String sg-xxxxxxxxx

安全组ID,多个安全组间用英文逗号(,)隔开。

说明
  • 1个集群最多支持3个安全组。
  • WhiteListType取值为SecurityGroup时本参数才可用。

返回数据

名称 类型 示例值 描述
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyDBClusterAccessWhitelist
&DBClusterId=pc-xxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDBClusterAccessWhitelistResponse>  
      <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterAccessWhitelistResponse>

JSON 格式

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

错误码

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