幫助中心
首頁 ApsaraDB for ClickHouse 開發參考 API參考（社區相容版） API目錄 其他 ModifyDBClusterAccessWhiteList - 修改白名單

ModifyDBClusterAccessWhiteList - 修改白名單

更新時間：
Copy as MD
產品

修改指定雲資料庫ClickHouse叢集的IP白名單。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:ModifyDBClusterAccessWhiteList

update

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
DBClusterId

string

是

叢集 ID。

cc-bp1qx68m06981****
SecurityIps

string

是

白名單，支援如下兩種格式：

  • IP 位址形式：例如 192.168.0.1 表示允許此 IP 位址訪問雲資料庫 ClickHouse。

  • IP 段形式：例如 192.168.0.0/24 表示允許從 192.168.0.1 到 192.168.0.255 的 IP 位址訪問雲資料庫 ClickHouse。

說明

  • 禁止輸入 IP: 0.0.0.0。

  • 設定為 127.0.0.1 代表禁止所有地址訪問。

192.168.xx.xx
DBClusterIPArrayName

string

否

需要修改的白名單分組名稱。

說明

不配置該參數時，預設修改 default 分組中的白名單。

default
DBClusterIPArrayAttribute

string

否

白名單分組屬性，預設為空。

NULL
ModifyMode

string

否

修改方式，取值說明：

  • Cover：覆蓋原白名單。

  • Append：在原白名單後追加修改的白名單。

  • Delete：刪除原白名單。

說明

不配置該參數時，預設採用 Cover 方式修改白名單。

Cover

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

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

變更歷史

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

上一篇：ModifyDBCluster - 對叢集進行升降配下一篇：ModifyDBClusterConfig