調(diào)用CreateDBNodes接口增加PolarDB集群的只讀節(jié)點(diǎn)。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 CreateDBNodes

系統(tǒng)規(guī)定參數(shù)。取值：CreateDBNodes。
ResourceGroupId String 否 rg-************

資源組ID。
DBClusterId String 是 pc-*************

集群ID。
ClientToken String 否 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

用于保證請(qǐng)求的冪等性，防止重復(fù)提交請(qǐng)求。由客戶端生成該參數(shù)值，保證在不同請(qǐng)求間唯一，大小寫敏感、不超過(guò)64個(gè)ASCII字符。
EndpointBindList String 否 pe-****************,pe-****************

指定新增節(jié)點(diǎn)需要加入的集群連接地址的地址ID。若需要同時(shí)加入多個(gè)連接地址，多個(gè)連接地址ID間用英文逗號(hào)（,）分隔。

說(shuō)明
  • 您可以通過(guò)調(diào)用DescribeDBClusterEndpoints接口查看集群連接地址的詳情，包括連接地址ID。
  • 支持填入默認(rèn)集群連接地址和自定義集群連接地址的地址ID。
  • 若該參數(shù)留空，默認(rèn)將新增節(jié)點(diǎn)加入所有開(kāi)啟了新節(jié)點(diǎn)自動(dòng)加入功能（即AutoAddNewNodes取值為Enable）的集群連接地址。
PlannedStartTime String 否 2021-01-14T09:00:00Z

開(kāi)始執(zhí)行定時(shí)（即在目標(biāo)時(shí)間段內(nèi)執(zhí)行）新增節(jié)點(diǎn)任務(wù)的最早時(shí)間。格式為YYYY-MM-DDThh:mm:ssZ（UTC）。

說(shuō)明
  • 開(kāi)始時(shí)間的取值范圍為未來(lái)24小時(shí)內(nèi)的任意時(shí)間點(diǎn)。例如當(dāng)前時(shí)間為2021-01-14T09:00:00Z，此處允許填入的開(kāi)始時(shí)間范圍為2021-01-14T09:00:00Z~2021-01-15T09:00:00Z。
  • 若該參數(shù)留空，默認(rèn)立即執(zhí)行新增節(jié)點(diǎn)任務(wù)。
PlannedEndTime String 否 2021-01-14T09:30:00Z

開(kāi)始執(zhí)行目標(biāo)定時(shí)任務(wù)的最晚時(shí)間。格式為YYYY-MM-DDThh:mm:ssZ（UTC）。

說(shuō)明
  • 最晚時(shí)間需晚于開(kāi)始時(shí)間的30分鐘或以上。
  • 若設(shè)置了PlannedStartTime但未指定該參數(shù)，執(zhí)行目標(biāo)任務(wù)的最晚時(shí)間默認(rèn)為開(kāi)始時(shí)間+30分鐘。例如當(dāng)設(shè)置PlannedStartTime為2021-01-14T09:00:00Z且該參數(shù)留空時(shí)，目標(biāo)任務(wù)最晚將于2021-01-14T09:30:00Z開(kāi)始執(zhí)行。
DBNode.N.TargetClass String 否 polar.mysql.x4.medium

新增節(jié)點(diǎn)的規(guī)格，需要與原有節(jié)點(diǎn)保持一致，詳情請(qǐng)參見(jiàn)如下文檔：

  • PolarDB MySQL版：計(jì)算節(jié)點(diǎn)規(guī)格。
  • PolarDB PostgreSQL版（兼容Oracle）：計(jì)算節(jié)點(diǎn)規(guī)格。
  • PolarDB PostgreSQL版：計(jì)算節(jié)點(diǎn)規(guī)格。
    說(shuō)明
    • DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一個(gè)。 N為從1開(kāi)始的整數(shù)，最大值=16-當(dāng)前節(jié)點(diǎn)數(shù)。
    • 當(dāng)前僅PolarDB MySQL版集群支持一次增加多個(gè)只讀節(jié)點(diǎn)，最多可增加至15個(gè)只讀節(jié)點(diǎn)。
    • 當(dāng)集群為PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版時(shí)，該參數(shù)必填；當(dāng)集群為PolarDB MySQL版時(shí)，該參數(shù)非必填。
DBNode.N.ZoneId String 否 cn-qingdao-c

新增節(jié)點(diǎn)的可用區(qū)，需要與原有節(jié)點(diǎn)保持一致。您可以通過(guò)DescribeRegions接口查詢可用區(qū)ID。

說(shuō)明
  • DBNode.N.ZoneId和DBNode.N.TargetClass，至少填一個(gè)。N為從1開(kāi)始的整數(shù)，最大值=16-當(dāng)前節(jié)點(diǎn)數(shù)。
  • 當(dāng)前僅PolarDB MySQL版集群支持一次增加多個(gè)只讀節(jié)點(diǎn)，最多可增加至15個(gè)只讀節(jié)點(diǎn)。
  • 當(dāng)集群為PolarDB PostgreSQL版（兼容Oracle）或PolarDB PostgreSQL版時(shí)，該參數(shù)必填；當(dāng)集群為PolarDB MySQL版時(shí)，該參數(shù)非必填。
ImciSwitch String 否 ON

是否開(kāi)啟列存索引。取值范圍：

  • ON：開(kāi)啟
  • OFF：關(guān)閉（默認(rèn)值）
說(shuō)明 PolarDB PostgreSQL版（兼容Oracle）和PolarDB PostgreSQL版不支持該參數(shù)。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
DBNodeIds Array of String pi-***************

創(chuàng)建的DBNodeId列表。
RequestId String E053E730-5755-4AA9-AA9D-A47867******

請(qǐng)求ID。
DBClusterId String pc-***************

數(shù)據(jù)庫(kù)集群ID。
OrderId String 2148126708*****

訂單ID。

示例

請(qǐng)求示例

http(s)://polardb.aliyuncs.com/?Action=CreateDBNodes
&ResourceGroupId=rg-************
&DBClusterId=pc-*************
&ClientToken=6000170000591aed949d0f54a343f1a4233c1e7d1c5c******
&EndpointBindList=pe-****************,pe-****************
&PlannedStartTime=2021-01-14T09:00:00Z
&PlannedEndTime=2021-01-14T09:30:00Z
&DBNode=[{"TargetClass":"polar.mysql.x4.medium","ZoneId":"cn-qingdao-c"}]
&ImciSwitch=ON
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式

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

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

JSON格式

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

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

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 ORDER.ARREARAGE 您有欠費(fèi)賬單，不符合購(gòu)買條件，請(qǐng)先結(jié)清賬單后再購(gòu)買 您有欠費(fèi)賬單，不符合購(gòu)買條件，請(qǐng)先結(jié)清賬單后再購(gòu)買
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 當(dāng)前的記錄中不存在提供的 DBClusterId。

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。