forked from docs/doc-exports
Ru, Li Yi
a6e39ff5b3
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
169 lines
13 KiB
HTML
169 lines
13 KiB
HTML
<a name="dds_api_0025"></a><a name="dds_api_0025"></a>
|
|
|
|
<h1 class="topictitle1">Adding Nodes for a Cluster Instance</h1>
|
|
<div id="body1542791497127"><div class="section" id="dds_api_0025__section15916231853"><h4 class="sectiontitle">Function</h4><p id="dds_api_0025__p464818237510">This API is used to add nodes for a specified cluster instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0025__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0025__ul994413182558"><li id="dds_api_0025__li1594421805513">Only the mongos and shard nodes can be added.</li><li id="dds_api_0025__li12543163317415">The specifications of the new node must be the same as those of the existing nodes in the instance.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0025__section2138231656"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0025__ul146486230516"><li id="dds_api_0025__li1964819235514">URI format<p id="dds_api_0025__p156482231050"><a name="dds_api_0025__li1964819235514"></a><a name="li1964819235514"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge</p>
|
|
</li><li id="dds_api_0025__li2648122312511">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0025__table1250923958" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0025__row86487235513"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0025__p7648142315510">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0025__p76481323053">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0025__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0025__row1564815238519"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0025__p26482231950">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0025__p206481423456">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0025__p8648192313511">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0025__row14648123253"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0025__p1164810233512">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0025__p1864872311517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0025__p15648192316515">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0025__section18134102315515"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0025__ul1686812517810"><li id="dds_api_0025__li386814511687">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0025__table201381923855" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0025__row7649423252"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0025__p2649523651">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0025__p1264932312515">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0025__p26495231353">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0025__p44372551324">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0025__row16491223858"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0025__p6649142316517">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0025__p364972317512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0025__p176494231859">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0025__p9649223356">Specifies the object to be scaled.</p>
|
|
<ul id="dds_api_0025__ul3979161754218"><li id="dds_api_0025__li6979517174215">Set the value to <strong id="dds_api_0025__b13331193218572">mongos</strong> if mongos nodes are to be added.</li><li id="dds_api_0025__li59798172421">Set the value to <strong id="dds_api_0025__b48706388576">shard</strong> if shard nodes are to be added.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0025__row36498239510"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0025__p493016184118">spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0025__p1264922317519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0025__p176497238517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0025__p964942312516">Specifies the resource specification code. For details about how to obtain the resource specification code, see the <strong id="dds_api_0025__b1240319316015">flavors.spec_code</strong> parameter in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0025__row265014238514"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0025__p156507231150">num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0025__p3650323554">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0025__p86502023155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0025__p959215914311">Specifies the number of mongos or shard nodes to be added. A cluster instance supports up to 32 mongos nodes and 32 shard nodes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0025__row8650202312514"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0025__p565018231558">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0025__p166508231553">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0025__p119963625111">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0025__p19747101018494">Specifies the volume information. For more information, see <a href="#dds_api_0025__table62051323653">Table 3</a>.</p>
|
|
<ul id="dds_api_0025__ul16360173118591"><li id="dds_api_0025__li4360183135910">This parameter is not transferred when the mongos nodes are to be added.</li><li id="dds_api_0025__li12360123105912">This parameter is mandatory when the shard nodes are to be added.<div class="note" id="dds_api_0025__note1855974514546"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0025__p392114555815">If multiple shards are added at a time, the shards must have the same specifications and disk capacity.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0025__table62051323653"></a><a name="table62051323653"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0025__table62051323653" frame="border" border="1" rules="all"><caption><b>Table 3 </b>volume field data structure description</caption><thead align="left"><tr id="dds_api_0025__row465052311516"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="dds_api_0025__p265017231512">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="dds_api_0025__p511718712328">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="dds_api_0025__p12650172316511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="dds_api_0025__p1266665916210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0025__row19650223358"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0025__p1365016232517">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0025__p15118187123217">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0025__p11650102315512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0025__p66500231253">Specifies the disk capacity of all new shards. The value range is from 10 GB to 2000 GB.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dds_api_0025__ul271016212710"><li id="dds_api_0025__li1371010220718">Example request<p id="dds_api_0025__p2015219103315"><a name="dds_api_0025__li1371010220718"></a><a name="li1371010220718"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge</p>
|
|
<div class="p" id="dds_api_0025__p91711791031">Number of mongos nodes to be added:<pre class="codeblock" id="dds_api_0025__codeblock19171791130">{
|
|
"type": "mongos",
|
|
"spec_code":"dds.mongodb.c3.medium.4.mongos",
|
|
"num": 1
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="dds_api_0025__p131718911311">Number of shard nodes to be added:<pre class="codeblock" id="dds_api_0025__codeblock5171179838">{
|
|
"type": "shard",
|
|
"spec_code":"dds.mongodb.c3.medium.4.shard",
|
|
"num": 1,
|
|
"volume": {
|
|
"size": 330
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
<div class="section" id="dds_api_0025__section332114231554"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0025__ul186519238513"><li id="dds_api_0025__li13651172316518">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0025__table133396233515" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0025__row165102318516"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="dds_api_0025__p116511423055">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="dds_api_0025__p6651023359">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.18%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="dds_api_0025__p7958933318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0025__row6651142313512"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0025__p1365114234513">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0025__p06510231257">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.18%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0025__p465172314518">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dds_api_0025__li66511823559">Response example<pre class="codeblock" id="dds_api_0025__codeblock165114233510">{
|
|
"job_id": "4008c8914b624785a02ab7966d4d"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0025__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0025__en-us_topic_0000001387505349_p16131712193312">Status Code:202.</p>
|
|
<p id="dds_api_0025__en-us_topic_0000001387505349_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0025__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0025__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|