創(chuàng)建或修改集群的白名單（包括IP白名單和安全組）。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| polardb:ModifyDBClusterAccessWhitelist | Write |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-************* |
| SecurityIps | string | 否 | IP 白名單分組中的 IP 地址或地址段。所有 IP 白名單分組累積支持 1000 個 IP 地址或地址段，多個 IP 間用英文逗號（,）隔開，支持如下兩種格式：
說明
當 WhiteListType 取值為 IP 時該參數(shù)才支持配置。
| 10.23.12.24 |
| DBClusterIPArrayName | string | 否 | IP 白名單分組的名稱。分組名稱長度需為 2~120 個字符；由小寫字母和數(shù)字組成；以字母開頭，以字母或數(shù)字結尾。
說明
| default |
| DBClusterIPArrayAttribute | string | 否 | IP 白名單分組屬性。設置為 hidden 后控制臺不可見。 說明
| hidden |
| WhiteListType | string | 否 | 白名單類型。取值范圍如下：
默認值為 IP。 | IP |
| SecurityGroupIds | string | 否 | 安全組 ID，多個安全組間用英文逗號（,）隔開。 說明
| sg-********* |
| ModifyMode | string | 否 | IP 白名單的修改方式，取值范圍如下：
說明
當 WhiteListType 取值為 IP 時該參數(shù)才支持配置。
| Cover |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | NumberExceed.securityGroupIds | The number of SecurityGroupIds exceeds 10. | 操作失敗，已超過安全組數(shù)量（上限：10個）。請修改后重試。 |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | 指定的安全IP列表無效：列表中有重復的IP地址 |
| 400 | InvalidSecurityIPList.Format | Specified security IP list format is not valid. | 指定的白名單IP地址格式錯誤。 |
| 400 | LockTimeout | The request processing has failed due to lock timeout. | 由于鎖定超時，請求處理失敗 |
| 403 | SecurityIPList.Duplicate | Specified same security IP already exists. | 指定的相同安全IP已存在 |
| 403 | OperationDenied.LockMode | The operation is not permitted when the instance is locked. | 操作失敗，狀態(tài)為鎖定的實例不支持該操作。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-06-12 | OpenAPI 錯誤碼發(fā)生變更 | 看變更集 | ||||||||
| ||||||||||
| 2023-04-24 | OpenAPI 錯誤碼發(fā)生變更 | 看變更集 | ||||||||
|