doc-exports/docs/geminidb/api-ref/nosql_05_0050.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

135 lines
9.2 KiB
HTML

<a name="nosql_05_0050"></a><a name="nosql_05_0050"></a>
<h1 class="topictitle1">Scaling Up Storage Space of an Instance</h1>
<div id="body1873329115116"><div class="section" id="nosql_05_0050__section773314917515"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0050__p187341193518">This API is used to scale up storage space of an instance.</p>
</div>
<div class="section" id="nosql_05_0050__section14736394517"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0050__nosql_05_0014_p153256865116">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_05_0050__section1375209195113"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0050__p175359115110">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__table1975611919515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0050__row775413914513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0050__p147573915117">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_0050__p177584914519">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_0050__p97591975115">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_0050__p1176017912518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__row17551495513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0050__p12760119145119">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0050__p376111917516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0050__p676216912519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0050__p1876312912510">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_0050__row167551695511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0050__p1576415905110">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0050__p1576512914519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0050__p5766179115110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0050__p16767191515">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0050__section3768398515"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0050__row117690920511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0050__p147712092510">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_0050__p117727965112">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_0050__p677329155118">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_0050__p167743955114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__row3769149145112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0050__p1973515400519">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_0050__p1677514910518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0050__p1477615945118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0050__p67779911515">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__request_ResizeInstanceVolumeRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0050__row87781498512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0050__p1978010910517">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_0050__p77821695517">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_0050__p17784209195114">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_0050__p9786198518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__row37786915517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0050__p18786596517">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0050__p37871935120">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0050__p5788159105111">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0050__p147891990516">Requested storage space. It must be an integer greater than the current storage space.</p>
<p id="nosql_05_0050__p1679029195118">The maximum storage space depends on the <span id="nosql_05_0050__text828036121815">API</span> type and specifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0050__section1980819155113"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0050__p158107975116"><strong id="nosql_05_0050__b1830492013213">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0050__response_ResizeInstanceVolumeResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0050__row881199185114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0050__p981319165110">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_0050__p881516915111">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_0050__p168163911519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0050__row1281119912515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0050__p282420955112">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0050__p188253925113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0050__p158273919513">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0050__section1083115919511"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0050__ul5832109175117"><li id="nosql_05_0050__li1867764121413">URI example<pre class="screen" id="nosql_05_0050__screen4677441101412">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume</pre>
</li><li id="nosql_05_0050__li14837129195115">Scaling up storage space of an instance to 550 GB<pre class="screen" id="nosql_05_0050__screen483849205116">{
"size" : 550
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0050__section198417917518"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0050__p28431997515"><strong id="nosql_05_0050__b1348020274218">Status code: 202</strong></p>
<p id="nosql_05_0050__p1384413935120">Accepted</p>
<pre class="screen" id="nosql_05_0050__screen1184579135120">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}</pre>
</div>
<div class="section" id="nosql_05_0050__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0050__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0050__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0050__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>