ModifySecurityIPList - 变更白名单_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

调用ModifySecurityIPList接口变更集群白名单设置。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:ModifySecurityIPList	update	EnterpriseDBCluster acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-beijing
DBInstanceId	string	是	集群 ID。	cc-xxxxx
GroupName	string	否	操作的分组名称。	test
SecurityIPList	string	否	白名单 IP 地址。	192.168.0.0/24,172.16.0.0/24
ModifyMode	string	否	修改模式。 0：覆盖修改 1：增加 2：删除说明建议固定指定 0 进行覆盖修改	0

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	xxx-xxx-xxx
Data	object	返回数据。
GroupName	string	分组名称。	test
SecurityIPType	string	IP 地址类型。	ipv4
GroupTag	string	分组标签。	test
TaskId	integer	任务 ID。	1
SecurityIPList	string	白名单分组下的 IP 列表。	192.168.0.0/24,172.16.0.0/24
DBInstanceID	integer	集群 ID。	cc-xxxx
WhitelistNetType	string	白名单的网络类型。	mix
DBInstanceName	string	集群名称。	cc-xxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "GroupName": "test",
    "SecurityIPType": "ipv4",
    "GroupTag": "test",
    "TaskId": 1,
    "SecurityIPList": "192.168.0.0/24,172.16.0.0/24",
    "DBInstanceID": 0,
    "WhitelistNetType": "mix",
    "DBInstanceName": "cc-xxxx"
  }
}

错误码

HTTP status code	错误码	错误信息
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.

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

变更历史

变更时间	变更内容概要	操作
2024-05-13	OpenAPI 错误码发生变更	查看变更详情