文档

CreateDBNodes - 增加PolarDB集群的只读节点

更新时间:

增加PolarDB集群的只读节点。

调试

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

授权信息

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

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

请求参数

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

资源组 ID。

rg-************
DBClusterIdstring

集群 ID。

pc-*************
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。

6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
EndpointBindListstring

指定新增节点需要加入的集群连接地址的地址 ID。若需要同时加入多个连接地址,多个连接地址 ID 间用英文逗号(,)分隔。

说明
  • 您可以通过调用 DescribeDBClusterEndpoints 接口查看集群连接地址的详情,包括连接地址 ID。
  • 支持填入默认集群连接地址和自定义集群连接地址的地址 ID。
  • 若该参数留空,默认将新增节点加入所有开启了新节点自动加入功能(即AutoAddNewNodes取值为Enable)的集群连接地址。
  • pe-****************,pe-****************
    PlannedStartTimestring

    开始执行定时(即在目标时间段内执行)新增节点任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

    说明
  • 开始时间的取值范围为未来 24 小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z,此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z
  • 若该参数留空,默认立即执行新增节点任务。
  • 2021-01-14T09:00:00Z
    PlannedEndTimestring

    开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

    说明
  • 最晚时间需晚于开始时间的 30 分钟或以上。
  • 若设置了PlannedStartTime但未指定该参数,执行目标任务的最晚时间默认为开始时间+30 分钟。例如当设置PlannedStartTime2021-01-14T09:00:00Z且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z开始执行。
  • 2021-01-14T09:30:00Z
    DBNodeobject []

    新增节点的信息。

    TargetClassstring

    新增节点的规格,需要与原有节点保持一致,详情请参见如下文档:

    说明
  • DBNode.N.ZoneId 和 DBNode.N.TargetClass,至少填一个。 N 为从 1 开始的整数,最大值=16-当前节点数。
  • 当前仅 PolarDB MySQL 版集群支持一次增加多个只读节点,最多可增加至 15 个只读节点。
  • 当集群为 PolarDB PostgreSQL 版(兼容 Oracle)或 PolarDB PostgreSQL 版时,该参数必填;当集群为 PolarDB MySQL 版时,该参数非必填。
  • polar.mysql.x4.medium
    ZoneIdstring

    新增节点的可用区,需要与原有节点保持一致。您可以通过 DescribeRegions 接口查询可用区 ID。

    说明
  • DBNode.N.ZoneId 和 DBNode.N.TargetClass,至少填一个。N 为从 1 开始的整数,最大值=16-当前节点数。
  • 当前仅 PolarDB MySQL 版集群支持一次增加多个只读节点,最多可增加至 15 个只读节点。
  • 当集群为 PolarDB PostgreSQL 版(兼容 Oracle)或 PolarDB PostgreSQL 版时,该参数必填;当集群为 PolarDB MySQL 版时,该参数非必填。
  • cn-qingdao-c
    DBNodeTypestring

    节点类型。取值范围:

    • RO
    • STANDBY
    • DLNode
    枚举值:
    • DLNodeai节点
    • STANDBYstandby节点
    • RO只读节点
    RO
    ImciSwitchstring

    是否开启列存索引。取值范围:

    • ON:开启

    • OFF:关闭(默认值)

    说明 PolarDB PostgreSQL 版(兼容 Oracle)和 PolarDB PostgreSQL 版不支持该参数。
    ON

    返回参数

    名称类型描述示例值
    object
    DBNodeIdsarray

    创建的 DBNodeId 列表。

    string

    创建的 DBNodeId 列表。

    pi-***************
    RequestIdstring

    请求 ID。

    E053E730-5755-4AA9-AA9D-A47867******
    DBClusterIdstring

    数据库集群 ID。

    pc-***************
    OrderIdstring

    订单 ID。

    2148126708*****

    示例

    正常返回示例

    JSON格式

    {
      "DBNodeIds": {
        "DBNodeId": [
          "pi-***************"
        ]
      },
      "RequestId": "E053E730-5755-4AA9-AA9D-A47867******",
      "DBClusterId": "pc-***************",
      "OrderId": "2148126708*****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ORDER.ARREARAGE您有欠费账单,不符合购买条件,请先结清账单后再购买您有欠费账单,不符合购买条件,请先结清账单后再购买
    400InvalidDBNodeNum.MalformedThe number of parameter DBNode.N is not valid.参数DBNode的数量无效
    400InvalidDBNode.MalformedThe specified parameter DBNode.N is not valid.指定的参数DBNode.N无效。
    400OperationDenied.CreateDBNodesWithStrictConsistencyOn3AZ cluster does not allow create db nodes.3AZ 集群不允许增加节点。
    400InvalidZoneId.MalformedThe specified parameter ZoneId is not valid.指定的参数ZoneId无效。
    403OperationDenied.ClusterCategoryThe operation is not permitted due to cluster category.该集群不支持此产品系列。
    403OperationDenied.DbVersionThe operation is not permitted due to DbVersion.由于DB版本问题,不允许执行此操作。
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      错误码 404 变更
      新增错误码:403
    2023-06-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:DBNodeType
    2022-01-13OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ImciSwitch