全部产品
Search

搜索本产品

    云原生数据库 PolarDB：ModifyDBClusterAccessWhitelist - 创建或修改集群的白名单

    文档中心

    云原生数据库 PolarDB：ModifyDBClusterAccessWhitelist - 创建或修改集群的白名单

    更新时间：Jun 17, 2024

    创建或修改集群的白名单（包括IP白名单和安全组）。

    调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    		pc-*************
    SecurityIpsstring否

    IP 白名单分组中的 IP 地址或地址段。所有 IP 白名单分组累积支持 1000 个 IP 地址或地址段，多个 IP 间用英文逗号（,）隔开，支持如下两种格式：

    • IP 地址形式，例如：10.23.12.24。
    • CIDR 形式，例如：10.23.12.24/24（无类域间路由，24 表示地址中前缀的长度，长度范围为 1~32）。
    说明 当 WhiteListType 取值为 IP 时该参数才支持配置。
    		10.23.12.24
    DBClusterIPArrayNamestring否

    IP 白名单分组的名称。分组名称长度需为 2~120 个字符；由小写字母和数字组成；以字母开头，以字母或数字结尾。

    • 如果传入的白名单分组名称不存在，则会创建该白名单分组。
    • 如果传入的白名单分组名称已存在，则会修改该白名单分组。
    • 不传入则修改 default 分组。
    说明
  • 1 个集群最多支持 50 个 IP 白名单分组。
  • 当 WhiteListType 取值为 IP 时该参数才支持配置。
    •
    		default
    DBClusterIPArrayAttributestring否

    IP 白名单分组属性。设置为 hidden 后控制台不可见。

    说明
  • 已在控制台显示的 IP 白名单分组不支持隐藏。
  • 当 WhiteListType 取值为 IP 时该参数才支持配置。
    •
    		hidden
    WhiteListTypestring否

    白名单类型。取值范围如下：

    • IP：IP 白名单分组。
    • SecurityGroup：安全组。

    默认值为 IP。

    		IP
    SecurityGroupIdsstring否

    安全组 ID，多个安全组间用英文逗号（,）隔开。

    说明
  • 1 个集群最多支持 3 个安全组。
  • 当 WhiteListType 取值为 SecurityGroup 时该参数才支持配置。
    •
    		sg-*********
    ModifyModestring否

    IP 白名单的修改方式，取值范围如下：

    • Cover：覆盖原 IP 白名单（默认值）。
    • Append：追加 IP。
    • Delete：删除 IP。
    说明 当 WhiteListType 取值为 IP 时该参数才支持配置。
    		Cover

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		D0CEC6AC-7760-409A-A0D5-E6CD86******

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

    错误码

    HTTP status code错误码错误信息描述
    400NumberExceed.securityGroupIdsThe number of SecurityGroupIds exceeds 10.操作失败，已超过安全组数量（上限：10个）。请修改后重试。
    400InvalidSecurityIPList.DuplicateSpecified security IP list is not valid: Duplicate IP address in the list指定的安全IP列表无效：列表中有重复的IP地址
    400InvalidSecurityIPList.FormatSpecified security IP list format is not valid.指定的白名单IP地址格式错误。
    400LockTimeoutThe request processing has failed due to lock timeout.由于锁定超时，请求处理失败
    403SecurityIPList.DuplicateSpecified same security IP already exists.指定的相同安全IP已存在
    403OperationDenied.LockModeThe operation is not permitted when the instance is locked.操作失败，状态为锁定的实例不支持该操作。
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2023-06-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      错误码 403 变更
      错误码 404 变更
    2023-04-24OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      删除错误码：403
      删除错误码：404