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>
173 lines
16 KiB
HTML
173 lines
16 KiB
HTML
<a name="opengauss_api_0019"></a><a name="opengauss_api_0019"></a>
|
|
|
|
<h1 class="topictitle1">Adding CNs</h1>
|
|
<div id="body8662426"><div class="section" id="opengauss_api_0019__saec4649e0fa9471886934279c588f00e"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0019__ad04795df5f3e48b2be1a0e800f87d2e1">This API is used to add CNs.</p>
|
|
<ul id="opengauss_api_0019__u3815f2da54114278bb08b17470934979"><li id="opengauss_api_0019__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_0019__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>
|
|
<div class="section" id="opengauss_api_0019__sc3e9363f382b4fb1b41ba4550b70194c"><h4 class="sectiontitle">Constraints</h4><ul id="opengauss_api_0019__ue94fd4a5d15648c59046386c263f4156"><li id="opengauss_api_0019__l4b1e18efc558473e9ee1e777c5d3d4b8">The CN growth increment ranges from 1 to 9.</li><li id="opengauss_api_0019__l77f49019c4244a1daa9ead01ec89d57a">The maximum number of CNs is 256.</li><li id="opengauss_api_0019__l66793227097a4d01ad3a1e3942731222">If you choose the single-AZ deployment during instance creation, add CNs in the same AZ.</li><li id="opengauss_api_0019__li9502451256">The number of CNs for a DB instance must be less than or equal to twice the number of shards.</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0019__s908fdf56e0f947969cfb77c218cf3aca"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0019__ub254bba213fa40a9813748c8ba9b78fe"><li id="opengauss_api_0019__la86ce8de45564b89a2cd40bc775312ba">URI format<p id="opengauss_api_0019__a738f25b9a2a94702b4ff1fe448d4486b"><a name="opengauss_api_0019__la86ce8de45564b89a2cd40bc775312ba"></a><a name="la86ce8de45564b89a2cd40bc775312ba"></a>POST https://{<em id="opengauss_api_0019__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{<em id="opengauss_api_0019__a797861718f8943fbaeb3e1fa7ecaf49e">project_id</em>}/instances/{<em id="opengauss_api_0019__en-us_topic_0248254027_i575217298119">instance_id</em>}/action</p>
|
|
</li><li id="opengauss_api_0019__l7f6439a7b71346788605a05a87418b55">Example<p id="opengauss_api_0019__a0333639b1be94cdc9c369d40fe8c39cc"><a name="opengauss_api_0019__l7f6439a7b71346788605a05a87418b55"></a><a name="l7f6439a7b71346788605a05a87418b55"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action</p>
|
|
</li><li id="opengauss_api_0019__l52f660320c5346b38362bf39b00aa30c">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0019__t9f4d827495a44b68ae8cfc68a4a9462a" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0019__rb8690a978d3b4876b1bb9ef4c90dafdd"><th align="left" class="cellrowborder" valign="top" width="23.102310231023104%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="opengauss_api_0019__a7dec768c09cd40e685d6d4d72b54ebef"><strong id="opengauss_api_0019__acb966ff3245b47b58e677cfd07abf8cf">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.602660266026607%" id="mcps1.3.3.2.3.1.2.4.1.2"><p id="opengauss_api_0019__afd75536c169e44bc9eadd7cfe043f3a3"><strong id="opengauss_api_0019__a0e55e6b69da04aae928f502f46dc2a40">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.29502950295029%" id="mcps1.3.3.2.3.1.2.4.1.3"><p id="opengauss_api_0019__a2122959b638b41ce871d1bd3fa08e2ac"><strong id="opengauss_api_0019__a0719f6ee716c47c1bd3823d2675b964b">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0019__r575529e1b405449d96b01652924022e8"><td class="cellrowborder" valign="top" width="23.102310231023104%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0019__en-us_topic_0248254027_p58122251454">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.602660266026607%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="opengauss_api_0019__a65b57cdfabef430c9533ab94a27aa9ec">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="opengauss_api_0019__en-us_topic_0248254027_p881412255459">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="opengauss_api_0019__p8544202712219">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="opengauss_api_0019__r2f8cde11ccdf4eeb842bc9aef890ba84"><td class="cellrowborder" valign="top" width="23.102310231023104%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0019__ae1a9f74bb1894a01a44c13cf5b71e373">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.602660266026607%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="opengauss_api_0019__ad14007ec966d4c229134665e640592d8">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.29502950295029%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="opengauss_api_0019__en-us_topic_0248254027_p981962520456">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0019__sec0648e0868842e387692ba772acc8b8"><h4 class="sectiontitle">Request</h4><ul id="opengauss_api_0019__u5ea30aff8c5e4a6c8bb696ba550dce9c"><li id="opengauss_api_0019__lfbfe0f0d0a7d43378fa57eced527b526">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0019__tf14de87497e64cf5b9af582eb77aa196" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0019__r79dc739edd1743efa09c0ea0bac8965c"><th align="left" class="cellrowborder" valign="top" width="17.87%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="opengauss_api_0019__en-us_topic_0248254027_p86417391376"><strong id="opengauss_api_0019__en-us_topic_0248254027_b627713565419">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.37%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="opengauss_api_0019__en-us_topic_0248254027_p96753916711"><strong id="opengauss_api_0019__en-us_topic_0248254027_b86866125413">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.59%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="opengauss_api_0019__en-us_topic_0248254027_p268239878"><strong id="opengauss_api_0019__acb3bd228ed794f38b6f1edffc9ec3338">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.17%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="opengauss_api_0019__en-us_topic_0248254027_p769133918716"><strong id="opengauss_api_0019__a753d58bfcec2409bb0d0dea6cb16e22c">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0019__r69defe0ac74a42f2972f488c2fcef515"><td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="opengauss_api_0019__en-us_topic_0248254027_p187053911714">expand_cluster</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.37%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="opengauss_api_0019__en-us_topic_0248254027_p871539878">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="opengauss_api_0019__a8a533d8a3d564dbd86a4ae6d943f01fb">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="opengauss_api_0019__en-us_topic_0248254027_p1672139273">For details, see <a href="#opengauss_api_0019__ta3716774d7224da5a2e283ca6b14a3f8">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0019__ta3716774d7224da5a2e283ca6b14a3f8"></a><a name="ta3716774d7224da5a2e283ca6b14a3f8"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0019__ta3716774d7224da5a2e283ca6b14a3f8" frame="border" border="1" rules="all"><caption><b>Table 3 </b>expand_cluster field data structure description</caption><thead align="left"><tr id="opengauss_api_0019__en-us_topic_0248254027_row9851859278"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="opengauss_api_0019__a546ad9e00c8540f5b82bb5b065cb5dca"><strong id="opengauss_api_0019__en-us_topic_0248254027_b195808295549">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.14%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="opengauss_api_0019__en-us_topic_0248254027_p97133113812"><strong id="opengauss_api_0019__en-us_topic_0248254027_b332573017544">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.86%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="opengauss_api_0019__en-us_topic_0248254027_p671491117810"><strong id="opengauss_api_0019__en-us_topic_0248254027_b188313115544">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.61%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="opengauss_api_0019__a3690dca415384526a8456b3297c9668a"><strong id="opengauss_api_0019__a8f1fe629ef4d410b855e4fbde031928a">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0019__rdf4473fc901b454caf28d3a0d8428fc7"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="opengauss_api_0019__en-us_topic_0248254027_p197182111783">coordinators</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.14%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="opengauss_api_0019__en-us_topic_0248254027_p6719311086">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="opengauss_api_0019__en-us_topic_0248254027_p27205111485">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="opengauss_api_0019__en-us_topic_0248254027_p57226111189">For details, see <a href="#opengauss_api_0019__t5f8b19c731a94a8f8a4f9d12c997c911">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0019__t5f8b19c731a94a8f8a4f9d12c997c911"></a><a name="t5f8b19c731a94a8f8a4f9d12c997c911"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0019__t5f8b19c731a94a8f8a4f9d12c997c911" frame="border" border="1" rules="all"><caption><b>Table 4 </b>azCode field data structure description</caption><thead align="left"><tr id="opengauss_api_0019__r0bccec10887644a39f299fe6e7668b29"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="opengauss_api_0019__en-us_topic_0248254027_p16854171102"><strong id="opengauss_api_0019__a9f04fd878d794b1d9c06237e5ed5f127">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.08%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="opengauss_api_0019__en-us_topic_0248254027_p136859175100"><strong id="opengauss_api_0019__en-us_topic_0248254027_b16684825413">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.92%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="opengauss_api_0019__a8eb396ab5b794bd88271951eb15b364c"><strong id="opengauss_api_0019__a8a2019e9dfe74029be997ca4d54c8fd2">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.61%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="opengauss_api_0019__en-us_topic_0248254027_p136859172104"><strong id="opengauss_api_0019__a07e7db17127640999bee05b51a0e23fc">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0019__r215de33bb9b248348c86003469784f0b"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="opengauss_api_0019__ab5679afefe6d4d65a2ab06d1914eb424">az_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.08%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="opengauss_api_0019__a129ab632b5fa41ff861ab8293ffa8777">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.92%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="opengauss_api_0019__en-us_topic_0248254027_p368581713102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="opengauss_api_0019__a5a3ffc744c264a36bd8274dd24844881">Specifies the AZ to which CNs are to be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="opengauss_api_0019__u0670fedca545442991413a083a0737e4"><li id="opengauss_api_0019__le39e26c3bc3d41ada46d6ca313e8836a">Example request (adding CNs for a single-CN instance)<pre class="codeblock" id="opengauss_api_0019__codeblock2057595111145">{
|
|
"expand_cluster": {
|
|
"coordinators": [
|
|
{
|
|
"az_code":"eu-de-01"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</li><li id="opengauss_api_0019__li433854121314">Example request (adding CNs for a multi-CN instance)<pre class="codeblock" id="opengauss_api_0019__codeblock10637134171514">{
|
|
"expand_cluster": {
|
|
"coordinators": [
|
|
{
|
|
"az_code":"eu-de-01"
|
|
},
|
|
{
|
|
"az_code":"eu-de-01"
|
|
},
|
|
{
|
|
"az_code":"eu-de-01"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0019__s867fe11fa7334a1a97f096812c164f47"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0019__uc5f44ab8d5a54a268524b172c28fd035"><li id="opengauss_api_0019__lffbdb4d874584cef82a522ac1b3287b3">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0019__tdda3a5007c674e86bd13877b937a7ada" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0019__ra62dcf8ae42b4b639327bb5b8e8860a7"><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_0019__a69d4fe2c5eef49e383b99cddeddedcf3"><strong id="opengauss_api_0019__en-us_topic_0248254027_b191754418552">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_0019__en-us_topic_0248254027_p879983818477"><strong id="opengauss_api_0019__en-us_topic_0248254027_b166811445557">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_0019__a85370533335f401b9e1e221263deefe7"><strong id="opengauss_api_0019__a176ab4bea3ca438a9a2afd45ab398e60">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0019__r32ea079ab40644f9820e8abc96cd30b2"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="opengauss_api_0019__a58f408add67747c5b6b6181cae9e3a9a">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_0019__en-us_topic_0248254027_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_0019__a8ed59bae2eeb4273b290db9b9bcd6693">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="opengauss_api_0019__u2bda73344c9d46778dcf7a049e06739e"><li id="opengauss_api_0019__l45ffc848bab342278f8c8b079c36881c">Example normal response<pre class="codeblock" id="opengauss_api_0019__cc3a04931e8564ac896a4ee968209e26f">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="opengauss_api_0019__l41dbffaf1de444f59949df61e2c99ca8">Abnormal response<p id="opengauss_api_0019__a72740c637ef6476e9c3c6e424dbe5aa7"><a name="opengauss_api_0019__l41dbffaf1de444f59949df61e2c99ca8"></a><a name="l41dbffaf1de444f59949df61e2c99ca8"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="opengauss_api_0019__s78243bb7cdf3431d801f57f8997526f6"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0019__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0019__s6aa09a92e7d64fb6bcc4f65caf3b8ba5"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0019__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>
|
|
|