forked from docs/doc-exports
Wang , Deng Ke
a96a12ecf1
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
131 lines
13 KiB
HTML
131 lines
13 KiB
HTML
<a name="opengauss_api_0020"></a><a name="opengauss_api_0020"></a>
|
|
|
|
<h1 class="topictitle1">Adding Shards</h1>
|
|
<div id="body8662426"><div class="section" id="opengauss_api_0020__sd612792150ae4b208a688aaf2ea8373a"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0020__a2cdf56d7b7d34086ae869e51663009e1">This API is used to add shards.</p>
|
|
<ul id="opengauss_api_0020__u7bce3f5bbe93412f846d251a70fcf7c0"><li id="opengauss_api_0020__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0020__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
<div class="note" id="opengauss_api_0020__n7e4e15b0d6394805875919dda3993058"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="opengauss_api_0020__en-us_topic_0248254028_p41118674718">Intermittent disconnection occurs when shards are being added. Exercise caution when performing this operation.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0020__s5ab19723e7ec4ea58ade2abb95f16179"><h4 class="sectiontitle">Constraints</h4><ul id="opengauss_api_0020__ub3de3cd018664fd1acf9f43545e4d868"><li id="opengauss_api_0020__l3fd217ac4b9444e5b0845d015030ed9f">The shard growth increment ranges from 1 to 9.</li><li id="opengauss_api_0020__l5c9ebc12077542a992a0c127acb13490">The maximum number of shards is 256.</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0020__s57208d65eff64f4b9f470411f0f50f52"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0020__uef1f19e4b9f14b85a3f328139ea8aa70"><li id="opengauss_api_0020__l096c3afe8cf74f1486544604422ea030">URI format<p id="opengauss_api_0020__aa15754bfe17c4b2984693497a7f3aeea"><a name="opengauss_api_0020__l096c3afe8cf74f1486544604422ea030"></a><a name="l096c3afe8cf74f1486544604422ea030"></a>POST https://{<em id="opengauss_api_0020__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{<em id="opengauss_api_0020__a2fd015359cac444ea0026c3d20ffd724">project_id</em>}/instances/{<em id="opengauss_api_0020__en-us_topic_0248254028_i575217298119">instance_id</em>}/action</p>
|
|
</li><li id="opengauss_api_0020__l84fb22ebad954a54bf08e6046394c43e">Example<p id="opengauss_api_0020__a4c6544bdeb964ef093db66e55e14c237"><a name="opengauss_api_0020__l84fb22ebad954a54bf08e6046394c43e"></a><a name="l84fb22ebad954a54bf08e6046394c43e"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action</p>
|
|
<ul id="opengauss_api_0020__u39da8dea28a742b6b8d554eecd99bc75"><li id="opengauss_api_0020__l471ae50f867640f9822e271930628a8a">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0020__tc2d8e97cd5444a20a6efb33c9e1fb44e" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0020__r3a1c61c293b84172b5588ac6b5017979"><th align="left" class="cellrowborder" valign="top" width="17.87%" id="mcps1.3.3.2.2.2.1.1.2.5.1.1"><p id="opengauss_api_0020__en-us_topic_0248254028_p178635485145"><strong id="opengauss_api_0020__en-us_topic_0248254028_b19172183524">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.37%" id="mcps1.3.3.2.2.2.1.1.2.5.1.2"><p id="opengauss_api_0020__en-us_topic_0248254028_p586384819144"><strong id="opengauss_api_0020__en-us_topic_0248254028_b351315194528">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.59%" id="mcps1.3.3.2.2.2.1.1.2.5.1.3"><p id="opengauss_api_0020__en-us_topic_0248254028_p386374814140"><strong id="opengauss_api_0020__en-us_topic_0248254028_b81371205526">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.17%" id="mcps1.3.3.2.2.2.1.1.2.5.1.4"><p id="opengauss_api_0020__a1b9905b948ee49b3b33c1092030cc2ac"><strong id="opengauss_api_0020__en-us_topic_0248254028_b68074205529">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0020__rb128a40951a943f1b10c9a048b686ce4"><td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.3.2.2.2.1.1.2.5.1.1 "><p id="opengauss_api_0020__a59aaf10494054d1c93ce41eae8aee154">expand_cluster</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.37%" headers="mcps1.3.3.2.2.2.1.1.2.5.1.2 "><p id="opengauss_api_0020__a64ddcf233f1f4e81845a6f7f236ceb48">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.2.2.2.1.1.2.5.1.3 "><p id="opengauss_api_0020__a11c0d6e7f20c4d539c15e79ff413a4ee">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.3.2.2.2.1.1.2.5.1.4 "><p id="opengauss_api_0020__en-us_topic_0248254028_p586417484144">For details, see <a href="#opengauss_api_0020__t30d289b02e32413f85de4f792ef2d605">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0020__t30d289b02e32413f85de4f792ef2d605"></a><a name="t30d289b02e32413f85de4f792ef2d605"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0020__t30d289b02e32413f85de4f792ef2d605" frame="border" border="1" rules="all"><caption><b>Table 2 </b>expand_cluster field data structure description</caption><thead align="left"><tr id="opengauss_api_0020__rcf422e653c104c82bb6131d9713ea6e4"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.3.2.2.2.1.2.2.5.1.1"><p id="opengauss_api_0020__acbe3458209e84d50be7975edeab9c881"><strong id="opengauss_api_0020__a5e081de4f0644b7bab5f416c53a66654">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.08%" id="mcps1.3.3.2.2.2.1.2.2.5.1.2"><p id="opengauss_api_0020__en-us_topic_0248254028_p686484851413"><strong id="opengauss_api_0020__ae215de0011234c8ea0a289bc53a90461">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.92%" id="mcps1.3.3.2.2.2.1.2.2.5.1.3"><p id="opengauss_api_0020__a0022ff11fe364bddb5585403d2673025"><strong id="opengauss_api_0020__a8bcf4f683a7d41be90e212b20419543c">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.61%" id="mcps1.3.3.2.2.2.1.2.2.5.1.4"><p id="opengauss_api_0020__afd163ac9233346e8ba36b7cb6382523d"><strong id="opengauss_api_0020__en-us_topic_0248254028_b647516379522">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0020__r0d7a3a17d3c44778a606e06efaed372d"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.2.2.2.1.2.2.5.1.1 "><p id="opengauss_api_0020__a293b2bfa3aef40e5ae61f7a1a3b9e693">shard</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.08%" headers="mcps1.3.3.2.2.2.1.2.2.5.1.2 "><p id="opengauss_api_0020__a2ab2860dfa5448ec94465f1a1fedccac">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.3.2.2.2.1.2.2.5.1.3 "><p id="opengauss_api_0020__a5e65ae9c46b64c99ac5f8f9d5e5a56df">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.3.2.2.2.1.2.2.5.1.4 "><p id="opengauss_api_0020__en-us_topic_0248254028_p128649481149">For details, see <a href="#opengauss_api_0020__td76b0f7b5e95419da36b3384c9439fb7">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0020__td76b0f7b5e95419da36b3384c9439fb7"></a><a name="td76b0f7b5e95419da36b3384c9439fb7"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0020__td76b0f7b5e95419da36b3384c9439fb7" frame="border" border="1" rules="all"><caption><b>Table 3 </b>count field data structure description</caption><thead align="left"><tr id="opengauss_api_0020__rec578d1eace0421f8a43091bcb8c434a"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.3.2.2.2.1.3.2.5.1.1"><p id="opengauss_api_0020__en-us_topic_0248254028_p16854171102"><strong id="opengauss_api_0020__en-us_topic_0248254028_b92398245312">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.08%" id="mcps1.3.3.2.2.2.1.3.2.5.1.2"><p id="opengauss_api_0020__en-us_topic_0248254028_p136859175100"><strong id="opengauss_api_0020__en-us_topic_0248254028_b1881721532">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.92%" id="mcps1.3.3.2.2.2.1.3.2.5.1.3"><p id="opengauss_api_0020__a5204c932d8f94ca7aa712594442706cb"><strong id="opengauss_api_0020__ae2076427d1ca4c488ee55bf4489aadca">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.61%" id="mcps1.3.3.2.2.2.1.3.2.5.1.4"><p id="opengauss_api_0020__en-us_topic_0248254028_p136859172104"><strong id="opengauss_api_0020__en-us_topic_0248254028_b74119475316">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0020__r27b43366f28646ad8d24e01b7ca22b72"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.3.2.2.2.1.3.2.5.1.1 "><p id="opengauss_api_0020__afa2ae4d1186c428d89ede7602845307c">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.08%" headers="mcps1.3.3.2.2.2.1.3.2.5.1.2 "><p id="opengauss_api_0020__ae45c15923cad4922969d75473017e63c">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.3.2.2.2.1.3.2.5.1.3 "><p id="opengauss_api_0020__en-us_topic_0248254028_p368581713102">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.3.2.2.2.1.3.2.5.1.4 "><p id="opengauss_api_0020__af0407f3a21c945528fd411f31fc6b4bb">Specifies the number of shards to be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0020__s08a80c46a2e544c3b3855359f77dc5bc"><ul id="opengauss_api_0020__en-us_topic_0248254028_ul66972122155"><li id="opengauss_api_0020__lb17f4a22d1e94d31ae18810fd1cf12e9">Request example<pre class="codeblock" id="opengauss_api_0020__c25293e07ffac4b2289a9efac18d75ae1">{
|
|
"expand_cluster": {
|
|
"shard":{
|
|
"count":"1"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0020__s67fed9781e924497857c485097160728"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0020__u10832b6b560844cfa82974970df78c43"><li id="opengauss_api_0020__l55a43a11f18849b5b586211627ba0d5a">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0020__t56b2b9b74b614fe1a778adc5bc3a766b" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0020__r84b7bb9f3d4c4865880de5ad415e5a3c"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="opengauss_api_0020__a578ff2bb8c384509b6408490b13d83f1"><strong id="opengauss_api_0020__en-us_topic_0248254028_b941053895312">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="opengauss_api_0020__en-us_topic_0248254028_p879983818477"><strong id="opengauss_api_0020__a33b5be73c3104ede9e09e92cd7fd5f94">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="opengauss_api_0020__aa9ffb28316a34f49976e9bea13fe9c68"><strong id="opengauss_api_0020__af9ab32d57bf947158e4590dfe2ce2b05">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0020__r401d854c2b13427f9b9ad8fc193c2af1"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="opengauss_api_0020__ab4bad7cb03e74f0f802ff4d3cbf5ba2d">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="opengauss_api_0020__en-us_topic_0248254028_p879983854715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="opengauss_api_0020__a7ec0ee1ecc42490380d852304a3cb50a">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="opengauss_api_0020__u9b17118ea46c4441bf032c0b300a6afb"><li id="opengauss_api_0020__l955079fe6db94181944e6e3cbf57b680">Example normal response<pre class="codeblock" id="opengauss_api_0020__ce7379f06d8514be5b81c9046234d8299">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="opengauss_api_0020__l25fe8471f81d48b189d63d284e126372">Abnormal response<p id="opengauss_api_0020__a72740c637ef6476e9c3c6e424dbe5aa7"><a name="opengauss_api_0020__l25fe8471f81d48b189d63d284e126372"></a><a name="l25fe8471f81d48b189d63d284e126372"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="opengauss_api_0020__sc7e09a4eab74431784d4cdf1918d05c1"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0020__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0020__sc1d8131c0dbe4ced837139a22ed27c8b"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0020__a478f17fa76dc42f792612496f9e1fdba">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0014.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|