ModifyClusterAccessWhiteList - 修改白名单

更新时间:2024-12-05 05:44:27

修改指定集群的IP白名单。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

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

请求参数

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

企业版、基础版或湖仓版的集群 ID。

amv-bp11q28kvl688****
SecurityIpsstring

集群的 IP 白名单,多个 IP 地址之间以英文逗号(,)隔开,不可重复,最多 500 个。支持如下两种格式:

  • IP 地址形式,例如:10.23.xx.xx。
  • CIDR 形式,例如:10.23.xx.xx/24(无类域间路由,24 表示了地址中前缀的长度,范围为 1~32)。
10.23.xx.xx
DBClusterIPArrayNamestring

IP 白名单分组名称,默认操作 Default 分组。

  • IP 白名单分组名称以小写字母开头、以数字或小写字母结尾,可包含小写字母、数字及下划线(_),长度为 2~32 个字符。
  • 单个集群最多支持 50 个白名单分组。
test
DBClusterIPArrayAttributestring

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

说明
控制台不显示带有“hidden”属性的分组,带有该标签的分组通常是用于访问 DTS、PolarDB 服务的。
hidden
ModifyModestring

修改白名单的方式,取值:

  • Cover(默认值):覆盖原 IP 白名单。
  • Append:追加 IP。
  • Delete:删除 IP。
Cover

返回参数

名称类型描述示例值
名称类型描述示例值
object
TaskIdinteger

任务 ID。

1564657730
RequestIdstring

请求 ID。

370D09FD-442A-5225-AAD3-7362CAE39177
DBClusterIdstring

企业版、基础版或湖仓版的集群 ID。

amv-bp11q28kvl688****

示例

正常返回示例

JSON格式

{
  "TaskId": 1564657730,
  "RequestId": "370D09FD-442A-5225-AAD3-7362CAE39177",
  "DBClusterId": "amv-bp11q28kvl688****"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400SecurityIPList.DuplicateThe specified IP address is duplicate.指定安全访问白名单IP重复
400InvalidDBClusterIPArrayName.MalformedThe specified parameter DBClusterIPArrayName is not valid.DBClusterIPArrayName参数不正确,请确认参数是否符合规范。
400InvalidSecurityIPList.MalformedThe specified SecurityIPList is incorrectly formatted.安全组参数不正确。
400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the listIP地址重复,请确认输入是否合法
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2023-03-31OpenAPI 错误码发生变更查看变更详情
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史