CreateDBNodes - 云原生关系型数据库 PolarDB PostgreSQL引擎

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	否	CreateDBNodes	系统规定参数。取值：CreateDBNodes。
DBClusterId	String	是	pc-*************	集群ID。
ClientToken	String	否	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。
EndpointBindList	String	否	pe-**************,pe-**************	指定新增节点需要加入的集群连接地址的地址ID。若需要同时加入多个连接地址，多个连接地址ID间用英文逗号（,）分隔。说明您可以通过调用DescribeDBClusterEndpoints接口查看集群连接地址的详情，包括连接地址ID。支持填入默认集群连接地址和自定义集群连接地址的地址ID。若该参数留空，默认将新增节点加入所有开启了新节点自动加入功能（即`AutoAddNewNodes`取值为`Enable`）的集群连接地址。
PlannedStartTime	String	否	2021-01-14T09:00:00Z	开始执行定时（即在目标时间段内执行）新增节点任务的最早时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。说明开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为`2021-01-14T09:00:00Z`，此处允许填入的开始时间范围为`2021-01-14T09:00:00Z`~`2021-01-15T09:00:00Z`。若该参数留空，默认立即执行新增节点任务。
PlannedEndTime	String	否	2021-01-14T09:30:00Z	开始执行目标定时任务的最晚时间。格式为`YYYY-MM-DDThh:mm:ssZ`（UTC）。说明最晚时间需晚于开始时间的30分钟或以上。若设置了`PlannedStartTime`但未指定该参数，执行目标任务的最晚时间默认为`开始时间+30分钟`。例如当设置`PlannedStartTime`为`2021-01-14T09:00:00Z`且该参数留空时，目标任务最晚将于`2021-01-14T09:30:00Z`开始执行。
DBNode.N.TargetClass	String	否	polar.mysql.x4.medium	新增节点的规格，需要与原有节点保持一致，关于节点规格，请参见计算节点规格。说明 DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。 N为从1开始的整数，最大值=16-当前节点数。当前仅PolarDB MySQL引擎集群支持一次增加多个只读节点，最多可增加至15个只读节点。当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时，该参数必填；当集群为PolarDB MySQL引擎时，该参数非必填。
DBNode.N.ZoneId	String	否	cn-qingdao-c	新增节点的可用区，需要与原有节点保持一致。您可以通过DescribeRegions接口查询可用区ID。说明 DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一个。N为从1开始的整数，最大值=16-当前节点数。当前仅PolarDB MySQL引擎集群支持一次增加多个只读节点，最多可增加至15个只读节点。当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时，该参数必填；当集群为PolarDB MySQL引擎时，该参数非必填。

返回数据


名称	类型	示例值	描述
DBNodeIds	Array of String	pi-***************	创建的DBNodeId列表。
RequestId	String	E053E730-5755-4AA9-AA9D-A47867******	请求ID。
DBClusterId	String	pc-***************	数据库集群ID。
OrderId	String	11111111111111	订单ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=CreateDBNodes
&DBClusterId=pc-*************
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBNodesResponse>
<DBNodeIds>
    <DBNodeId>pi-***************</DBNodeId>
    <DBNodeId>pi-***************</DBNodeId>
</DBNodeIds>
<RequestId>E053E730-5755-4AA9-AA9D-A47867******</RequestId>
<DBClusterId>pc-***************</DBClusterId>
<OrderId>11111111111111</OrderId>
</CreateDBNodesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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