調用ModifyDBClusterAccessWhitelist接口創建或修改PolarDB集群的白名單（包括IP白名單和安全組）。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 否 ModifyDBClusterAccessWhitelist

系統規定參數，取值為ModifyDBClusterAccessWhitelist。

DBClusterId String 是 pc-*************

集群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 否 10.23.12.24

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-*********

安全組ID，多個安全組間用英文逗號（,）隔開。

說明
  • 1個集群最多支持3個安全組。
  • 當WhiteListType取值為SecurityGroup時該參數才支持配置。

返回數據

名稱 類型 示例值 描述
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD86******

請求ID。

示例

請求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterAccessWhitelist
&DBClusterId=pc-*************
&<公共請求參數>

正常返回示例

XML 格式 

<ModifyDBClusterAccessWhitelistResponse>  
      <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>
</ModifyDBClusterAccessWhitelistResponse>

JSON 格式 

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。