vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_05_0051.html
Ru, Li Yi 37b97ffc06 geminidb_api 
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>
2024-07-04 11:26:33 +00:00

143 lines
10 KiB
HTML
Raw Blame History

<a name="nosql_05_0051"></a><a name="nosql_05_0051"></a>
<h1 class="topictitle1">Adding Nodes for an Instance</h1>
<div id="body154313106514"><div class="section" id="nosql_05_0051__section15431171095117"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0051__p7432191095110">This API is used to add nodes for a specified instance.</p>
</div>
<div class="section" id="nosql_05_0051__section643301019517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0051__p1243321045113">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_05_0051__section9441181035119"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0051__p0441171055112">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-node</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__table124431010135114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0051__row1044291013510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0051__p17443110135111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0051__p244441013515">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_05_0051__p5444161005113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_05_0051__p17445151019517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__row94429108518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0051__p14445111095114">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0051__p1044641095112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0051__p14461410115115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0051__p844761010519">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="nosql_05_0051__row10442111016515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0051__p1447131019514">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0051__p134481510115112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0051__p14482010195117">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0051__p9449171015113">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0051__section4449171015512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0051__row11450201015117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0051__p945151020514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0051__p18451151095117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0051__p11451710125113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0051__p94521110195113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__row16450210165110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0051__p4459111075117">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0051__p04627104519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0051__p3463810175118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0051__p1946321015120">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__request_ExpandInstanceNodeRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0051__row6464111014517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0051__p846561065118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0051__p4466121025114">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_05_0051__p8466191018511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_05_0051__p1846781045112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__row12464151017515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0051__p846818108516">num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0051__p746801005117">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0051__p1546961075115">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0051__p19470171025114">Number of new nodes.</p>
</td>
</tr>
<tr id="nosql_05_0051__row15464710205116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0051__p64701310195116">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0051__p2471410165114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0051__p1747110107512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0051__p6472111085111">ID of the subnet where the new node is deployed.</p>
<ul id="nosql_05_0051__ul11472710165115"><li id="nosql_05_0051__li347291065114">This parameter can be transferred when nodes are added to the <span id="nosql_05_0051__text1733917587219">GeminiDB Cassandra</span> database instances.</li><li id="nosql_05_0051__li1747321095115">The transferred subnet ID must belong to the VPC where the current instance is deployed.</li><li id="nosql_05_0051__li1447381025113">If this parameter is not transferred, the system will allocate a subnet with sufficient IP addresses for the new node.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0051__section1476171035111"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0051__p2477191011519"><strong id="nosql_05_0051__b783421182119">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0051__response_ExpandInstanceNodeResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0051__row1047791013513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0051__p11478910135110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_05_0051__p12479310165110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_05_0051__p9479101019519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0051__row04776107513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0051__p17480121055111">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0051__p104801106518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0051__p848171012513">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0051__section748216106513"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0051__ul148314108517"><li id="nosql_05_0051__li1735645731913">URI example<pre class="screen" id="nosql_05_0051__screen43561157181914">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node</pre>
</li><li id="nosql_05_0051__li174858108514">Adding a node<pre class="screen" id="nosql_05_0051__screen1748641045115">{
"num" : 1
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0051__section164875101514"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0051__p94876100511"><strong id="nosql_05_0051__b329185142110">Status code: 202</strong></p>
<p id="nosql_05_0051__p64881210175115">Accepted</p>
<pre class="screen" id="nosql_05_0051__screen6488171017518">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}</pre>
</div>
<div class="section" id="nosql_05_0051__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0051__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0051__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0051__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
</div>
</div>
View Git Blame Copy Permalink