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>
132 lines
13 KiB
HTML
132 lines
13 KiB
HTML
<a name="opengauss_api_0016"></a><a name="opengauss_api_0016"></a>
|
|
|
|
<h1 class="topictitle1">Scaling Up Storage Space of a DB Instance</h1>
|
|
<div id="body8662426"><div class="section" id="opengauss_api_0016__sdea71c5aca9e4cbfbbb08daa2caf7c5b"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0016__ace3299b41e834ccfbda8f2455390dddb">This API is used to scale up storage space of a DB instance.</p>
|
|
<ul id="opengauss_api_0016__u118f30ba86ff435f821095768243fb0d"><li id="opengauss_api_0016__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_0016__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_0016__s32e698cf6c3a4422a71e93e41340d0d1"><h4 class="sectiontitle">Constraints</h4><ul id="opengauss_api_0016__ub8d4875a82344eea8caa4559d7ecb825"><li id="opengauss_api_0016__li201521733185413">The storage space must be a multiple of the number of shards multiplied by 40 GB.</li><li id="opengauss_api_0016__li149603343541">All nodes must be available.</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0016__s8ffca7efe76b472684b5d2ed883da514"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0016__u03d08ea140884a75becb9f59d88c9692"><li id="opengauss_api_0016__l182a6048df4d40c0b00de11b922ea856">URI format<p id="opengauss_api_0016__abffe81ee92aa4c708f5d5acafa07c63b"><a name="opengauss_api_0016__l182a6048df4d40c0b00de11b922ea856"></a><a name="l182a6048df4d40c0b00de11b922ea856"></a>POST https://{<em id="opengauss_api_0016__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}/action</p>
|
|
</li><li id="opengauss_api_0016__l3f67a843e33a482fa7a29f1a7c8d79e2">Example<p id="opengauss_api_0016__a1bf5039200174f1d8354a0d2ac6dbab5"><a name="opengauss_api_0016__l3f67a843e33a482fa7a29f1a7c8d79e2"></a><a name="l3f67a843e33a482fa7a29f1a7c8d79e2"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action</p>
|
|
</li><li id="opengauss_api_0016__lfe1cf6d866134a31ba23aea319253cc0">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0016__t46fe89c151054e0e9e908012ae71e79e" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0016__rda1aa2be85b646d189fcaefc1e42ccc0"><th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="opengauss_api_0016__en-us_topic_0151958051_p187572313527"><strong id="opengauss_api_0016__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="opengauss_api_0016__a817b2098891440cd9af2929328b3bd77"><strong id="opengauss_api_0016__a9cf4e384a229401280109aa39a271221">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="opengauss_api_0016__a4e5f39eac8824ac080823e231da485c6"><strong id="opengauss_api_0016__af6e688e9368848149e49d370b6c8540d">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0016__rf2a39f3b56524e5f8116ff140610d5b1"><td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0016__a90f4912726f640219583191ea0371ea7">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="opengauss_api_0016__a4486f172a2e848a886211baa23e84d3f">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.510000000000005%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="opengauss_api_0016__en-us_topic_0151958051_p887592312524">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="opengauss_api_0016__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_0016__rc47e5ab9fc17477abebc810e59fd582e"><td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0016__ac01a7cc668404b83840b96e37c352971">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="opengauss_api_0016__aa4f47c440c3e410194e62a362c9eaa95">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.510000000000005%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="opengauss_api_0016__en-us_topic_0151958051_p287552395211">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0016__s625a3eaa41884791aa8e5cd0fc4e3eaf"><h4 class="sectiontitle">Request</h4><ul id="opengauss_api_0016__u0969f7afa0f842f5b55521f926a419e1"><li id="opengauss_api_0016__l2513b8d78fa34005ae91425c7a160a89">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0016__tb5b832857b0e4b3bb4b0f8601734bfaa" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0016__r18b7413528d74c7fab0b5a469e746e81"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="opengauss_api_0016__a96f959b310dd437780e1a91e2a840b80"><strong id="opengauss_api_0016__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="opengauss_api_0016__en-us_topic_0151958051_p287512375212"><strong id="opengauss_api_0016__a32ba0418330a47709833ac9995a636cc">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="opengauss_api_0016__ae1f9236ee14d45dc8dc6606d77f08ad3"><strong id="opengauss_api_0016__a9f51dd1c2b4e488abcce04540c6e7a7f">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="opengauss_api_0016__en-us_topic_0151958051_p198753239523"><strong id="opengauss_api_0016__aef907ea2ae3d4fc7a7e2cba7d1e3c4a1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0016__rca8aff89e9dc4c42a3a9547bc749ba0f"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="opengauss_api_0016__a20c26b7441c949b2a71e27cd828b4f43">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="opengauss_api_0016__a51c26efa248d4d3a9fc2e2c6ccccdad2">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="opengauss_api_0016__af932a46aaba3432ebb596eef47bbc28b">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="opengauss_api_0016__en-us_topic_0151958051_p846065413298">Specifies the target storage space after scaling up.</p>
|
|
<p id="opengauss_api_0016__aea7db5cc098a4f89af5ba04b159e1277">For details, see <a href="#opengauss_api_0016__tb1bbcd595e9c42c58c9e8299b02d08d6">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0016__tb1bbcd595e9c42c58c9e8299b02d08d6"></a><a name="tb1bbcd595e9c42c58c9e8299b02d08d6"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0016__tb1bbcd595e9c42c58c9e8299b02d08d6" frame="border" border="1" rules="all"><caption><b>Table 3 </b>enlarge_volume field data structure description</caption><thead align="left"><tr id="opengauss_api_0016__r1601e0cfd01a4400a5d21bbb36c0e7ba"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="opengauss_api_0016__en-us_topic_0151958051_p76528217317"><strong id="opengauss_api_0016__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="opengauss_api_0016__en-us_topic_0151958051_p465452163114"><strong id="opengauss_api_0016__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="opengauss_api_0016__ab8bdf737cd064719a285ef8744525148"><strong id="opengauss_api_0016__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="opengauss_api_0016__abb0b53b9147e404d9bc80fa77fcd4ba2"><strong id="opengauss_api_0016__en-us_topic_0151958051_b480591613520">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0016__r61f4419372d549629baeefa0433436ee"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="opengauss_api_0016__a0964aa16c05f4beb8a54217886e1e5ac">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.17%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="opengauss_api_0016__afb9ca998bae14f7cadff11c78d02dc30">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="opengauss_api_0016__a284c1f2016b84d1fa25c59214e6b5b0b">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.42%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="opengauss_api_0016__ab9059159f6b44953ab7111be315a92e4">Specifies the storage space, which must always be an integral multiple of (Number of shards x 40 GB). Minimum storage space = Number of shards x 40 GB. Maximum storage space = Number of shards x 16 TB.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="opengauss_api_0016__u36520c48755441f3b05cc1e616b3c590"><li id="opengauss_api_0016__l397078d302c24a1db049a771d9c5f91e">Request example<pre class="codeblock" id="opengauss_api_0016__cfc3b7c9a5aaf4d239ac91f771ab1d6fa">{
|
|
"enlarge_volume": {
|
|
"size": 400
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="opengauss_api_0016__s28a97144920d475c80a737d8fa56c0a1"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0016__en-us_topic_0151958051_ul28758235521"><li id="opengauss_api_0016__lba496c984593405597f9f66185cc25aa">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0016__t15d7a65c6a2347b1bbd29f16e3ad488a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0016__r09d75d763f3443529ea715ce9128a9fe"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="opengauss_api_0016__en-us_topic_0151958051_p128770232529"><strong id="opengauss_api_0016__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="opengauss_api_0016__aeb733230e32948979561bbd5a8dd093f"><strong id="opengauss_api_0016__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="opengauss_api_0016__en-us_topic_0151958051_p78775237527"><strong id="opengauss_api_0016__a9620bd75239a4ab5a792eb6b4d691489">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0016__rb21dce16485d4aa39cb5d2103e05c21f"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="opengauss_api_0016__aa6440a9cac9645c49020694538fcdf65">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="opengauss_api_0016__a6b6cde184f3b409f9970add7d30d6010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="opengauss_api_0016__en-us_topic_0151958051_p887719239520">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="opengauss_api_0016__u24216f0ea4c74c88b5513a3cf0b96c1a"><li id="opengauss_api_0016__lac8b2d90da854fae8e6783616578d3c4">Example normal response<pre class="codeblock" id="opengauss_api_0016__cb865d2c206c74f259bdac4ef8c7f9e9e">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="opengauss_api_0016__en-us_topic_0151958051_li4328453192">Abnormal response<p id="opengauss_api_0016__a4af2a65f22ba4bb488f69daa4f9344d8"><a name="opengauss_api_0016__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="opengauss_api_0016__sc66945da12024c3e9366242c1e4645a1"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0016__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0016__scd31f3c428d340e490758a45a8d16d0d"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0016__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>
|
|
|