全部產品
Search

搜尋本產品

    ：ModifyDBClusterAccessWhitelist - 建立或修改叢集的白名單

    文件中心

    ：ModifyDBClusterAccessWhitelist - 建立或修改叢集的白名單

    更新時間：Dec 11, 2025

    建立或修改叢集的白名單（包括IP白名單和安全性群組）。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:ModifyDBClusterAccessWhitelist

    update

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    pc-*************
    SecurityIps

    string

    否

    IP 白名單分組中的 IP 位址或位址區段。所有 IP 白名單分組累積支援 1000 個 IP 位址或位址區段，多個 IP 間用英文逗號（,）隔開，支援如下兩種格式：

    • IP 位址形式，例如：10.23.12.24。

    • CIDR 形式，例如：10.23.12.24/24（無類域間路由，24 表示地址中首碼的長度，長度範圍為 1~32）。

    說明

    當 WhiteListType 取值為 IP 時該參數才支援配置。

    10.23.12.24
    DBClusterIPArrayName

    string

    否

    IP 白名單分組的名稱。分組名稱長度需為 2~120 個字元；由小寫字母和數字組成；以字母開頭，以字母或數字結尾。

    • 如果傳入的白名單分組名稱不存在，則會建立該白名單分組。

    • 如果傳入的白名單分組名稱已存在，則會修改該白名單分組。

    • 不傳入則修改 default 分組。

    說明

    • 1 個叢集最多支援 50 個 IP 白名單分組。

    • 當 WhiteListType 取值為 IP 時該參數才支援配置。

    default
    DBClusterIPArrayAttribute

    string

    否

    IP 白名單分組屬性。設定為 hidden 後控制台不可見。

    說明

    • 已在控制台顯示的 IP 白名單分組不支援隱藏。

    • 當 WhiteListType 取值為 IP 時該參數才支援配置。

    hidden
    WhiteListType

    string

    否

    白名單類型。取值範圍如下：

    • IP：IP 白名單分組。

    • SecurityGroup：安全性群組。

    預設值為 IP。

    IP
    SecurityGroupIds

    string

    否

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

    說明

    • 1 個叢集最多支援 3 個安全性群組。

    • 當 WhiteListType 取值為 SecurityGroup 時該參數才支援配置。

    sg-*********
    ModifyMode

    string

    否

    IP 白名單的修改方式，取值範圍如下：

    • Cover：覆蓋原 IP 白名單（預設值）。

    • Append：追加 IP。

    • Delete：刪除 IP。

    說明

    當 WhiteListType 取值為 IP 時該參數才支援配置。

    Cover

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    D0CEC6AC-7760-409A-A0D5-E6CD86******

    樣本

    正常返回樣本

    JSON格式

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

    異常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 NumberExceed.securityGroupIds The number of SecurityGroupIds exceeds 10. 操作失敗，已超過安全性群組數量（上限：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. 操作失敗，狀態為鎖定的執行個體不支援該操作。
    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。

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

    變更歷史

    更多資訊，參考變更詳情。