修改指定集群的IP白名单。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| adb:ModifyClusterAccessWhiteList | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 企业版、基础版或湖仓版的集群 ID。 | amv-bp11q28kvl688**** |
| SecurityIps | string | 是 | 集群的 IP 白名单，多个 IP 地址之间以英文逗号（,）隔开，不可重复，最多 500 个。支持如下两种格式：
| 10.23.xx.xx |
| DBClusterIPArrayName | string | 否 | IP 白名单分组名称，默认操作 Default 分组。
| test |
| DBClusterIPArrayAttribute | string | 否 | 白名单分组属性，默认为空。 说明
控制台不显示带有“hidden”属性的分组，带有该标签的分组通常是用于访问 DTS、PolarDB 服务的。
| hidden |
| ModifyMode | string | 否 | 修改白名单的方式，取值：
| Cover |
返回参数
示例
正常返回示例
JSON格式
{
"TaskId": 1564657730,
"RequestId": "370D09FD-442A-5225-AAD3-7362CAE39177",
"DBClusterId": "amv-bp11q28kvl688****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | SecurityIPList.Duplicate | The specified IP address is duplicate. | 指定安全访问白名单IP重复 |
| 400 | InvalidDBClusterIPArrayName.Malformed | The specified parameter DBClusterIPArrayName is not valid. | DBClusterIPArrayName参数不正确，请确认参数是否符合规范。 |
| 400 | InvalidSecurityIPList.Malformed | The specified SecurityIPList is incorrectly formatted. | 安全组参数不正确。 |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | IP地址重复，请确认输入是否合法 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-31 | OpenAPI 错误码发生变更 | 查看变更详情 |