全部产品
Search

搜索本产品

    云数据库 ClickHouse：ModifyDBClusterAccessWhiteList - 修改白名单

    文档中心

    云数据库 ClickHouse：ModifyDBClusterAccessWhiteList - 修改白名单

    更新时间：Dec 05, 2024

    修改指定云数据库ClickHouse集群的IP白名单。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    clickhouse:ModifyDBClusterAccessWhiteListupdate
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    		cc-bp1qx68m06981****
    SecurityIpsstring是

    白名单，支持如下两种格式：

    • 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
    DBClusterIPArrayNamestring否

    需要修改的白名单分组名称。

    说明 不配置该参数时，默认修改 default 分组中的白名单。
    		default
    DBClusterIPArrayAttributestring否

    白名单分组属性，默认为空。

    		NULL
    ModifyModestring否

    修改方式，取值说明：

    • Cover：覆盖原白名单。
    • Append：在原白名单后追加修改的白名单。
    • Delete：删除原白名单。
    说明 不配置该参数时，默认采用 Cover 方式修改白名单。
    		Cover

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-10-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情