創建或修改集群的白名單（包括IP白名單和安全組）。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| adb:ModifyDBClusterAccessWhiteList | update |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | rm-uf6wjk5xxxxxxxxxx |
| SecurityIps | string | 是 | 集群的 IP 白名單，多個 IP 地址之間以英文逗號（,）隔開，不可重復，最多 500 個。支持如下兩種格式：
說明
ModifyMode 值為 Delete 時，此參數值可以是空，其他情況下必須有非空值。
| 10.23.12.24 |
| DBClusterIPArrayName | string | 否 | 需要修改的 IP 白名單分組名稱，默認操作 Default 分組。 IP 白名單分組名稱以小寫字母開頭、以數字或小寫字母結尾，可包含小寫字母、數字及’_’，長度為 2~32。 單個集群最多支持 50 個白名單分組。 | test |
| DBClusterIPArrayAttribute | string | 否 | 白名單分組屬性，默認為空。 控制臺不顯示帶有 hidden 屬性的分組，帶有該標簽的分組通常是用于訪問 DTS、DRDS 服務的。 | hidden |
| ModifyMode | string | 否 | 修改白名單的方式。取值：
默認值：Cover。 | Cover |
返回參數
示例
正常返回示例
JSON格式
{
"TaskId": 1564657730,
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
"DBClusterId": "rm-uf6wjk5xxxxxxxxxx"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | SecurityIPList.Duplicate | The specified IP address is duplicate. | 指定安全訪問白名單IP重復 |
| 400 | InvalidSecurityIPList.Malformed | The specified SecurityIPList is incorrectly formatted. | 安全組參數不正確。 |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | IP地址重復，請確認輸入是否合法 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-04-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |