lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_api_1016.html
Ru, Li Yi d97aea4dd2 opengauss_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-09-06 09:04:21 +00:00

134 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001917130496"></a><a name="EN-US_TOPIC_0000001917130496"></a>
<h1 class="topictitle1">Scaling up Storage Space of a DB Instance</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section150205102514"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p58741223125210">This API is used to scale up storage space of a DB instance. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section1213231413285"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul116721736162812"><li id="EN-US_TOPIC_0000001917130496__li201521733185413">The storage space must be a multiple of the number of shards multiplied by 40 GB.</li><li id="EN-US_TOPIC_0000001917130496__li149603343541">All nodes must be available.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section106755832618"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul1487413230526"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li14874623115217">URI format<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p9874142312522"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li14874623115217"></a><a name="en-us_topic_0151958051_li14874623115217"></a>POST https://{<em id="EN-US_TOPIC_0000001917130496__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}/action</p>
</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li4411135064210">Example<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p1454414211213"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li4411135064210"></a><a name="en-us_topic_0151958051_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action</p>
</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li187472315526">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table1576811235520" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row18751223155212"><th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p187572313527"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b35402365325">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.8%" id="mcps1.3.3.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p10875132325219"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b6413113714325">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.510000000000005%" id="mcps1.3.3.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p12875122313523"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b12444133803216">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row178751238528"><td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p128751523105218">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.8%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p108751223195218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="54.510000000000005%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p887592312524">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917130496__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row387582335220"><td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p20875102318523">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.8%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p15875723185214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="54.510000000000005%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p287552395211">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li387592375220">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table477719232522" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row118759235520"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p1587542375213"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b361919271133">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p287512375212"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b19379132816317">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p8875152313526"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b11458122914311">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.76%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p198753239523"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b1992683115317">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row1387582319526"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p9875523185210">enlarge_volume</p>
</td>
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p168751823115220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_a9a9492e05cb648e885d1e747a339d04d">Object</p>
</td>
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p846065413298">Target storage space after scaling up.</p>
<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p18912221165218">For details, see <a href="#EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table17521151123114">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table17521151123114"></a><a name="en-us_topic_0151958051_table17521151123114"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table17521151123114" frame="border" border="1" rules="all"><caption><b>Table 3 </b>enlarge_volume field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row185241211173113"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p76528217317"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b01241813358">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.17%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p465452163114"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b129569148515">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p1965410210319"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b789431511516">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.42%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p56571521103120"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b480591613520">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row852415112319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p11659182173118">size</p>
</td>
<td class="cellrowborder" valign="top" width="18.17%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p06611021153118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p18661192153116">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.42%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p1066392103115">Storage space, which must always be a multiple of (Number of shards x 40 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul3875152311524"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li18875142335210">Example request<pre class="codeblock" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_codeblock15594173112344">{
"enlarge_volume": {
"size": 400
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section159912464345"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul28758235521"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li158771723155214">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_table137871523165214" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row38777235523"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p128770232529"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b13872423519">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p78771723175214"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b157010441657">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p78775237527"><strong id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_b1698715451955">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_row6877523135212"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p48771723115210">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p4877182318524">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p887719239520">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_ul42421820113517"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li5242142010359">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_codeblock1214473263512">{
"job_id": "2b414788a6004883a02390e2eb0ea227"
}</pre>
</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li4328453192">Abnormal response<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_p58771023185211"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_li4328453192"></a><a name="en-us_topic_0151958051_li4328453192"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a>202</p>
</li><li id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917130496__en-us_topic_0151958051_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917130496__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">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_1014.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink