forked from docs/doc-exports
Ru, Li Yi
a6e39ff5b3
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>
154 lines
11 KiB
HTML
154 lines
11 KiB
HTML
<a name="dds_api_0024"></a><a name="dds_api_0024"></a>
|
|
|
|
<h1 class="topictitle1">Scaling Up Storage Space</h1>
|
|
<div id="body1542791497127"><div class="section" id="dds_api_0024__section1871012287914"><h4 class="sectiontitle">Function</h4><p id="dds_api_0024__p162352291597">This API is used to scale up the storage space of a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0024__section167151728690"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0024__ul52354291591"><li id="dds_api_0024__li823532915915">URI format<p id="dds_api_0024__p152357291596"><a name="dds_api_0024__li823532915915"></a><a name="li823532915915"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-volume</p>
|
|
</li><li id="dds_api_0024__li1123572912915">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0024__table373212284910" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0024__row14235529895"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0024__p1523519291293">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0024__p1823518291297">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0024__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0024__row623562916918"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0024__p1123514291916">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0024__p223516292919">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0024__p1323512294917">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0024__row122352293919"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0024__p1223682919913">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0024__p72367292914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0024__p13236829499">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0024__section137938281916"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0024__ul115281033171811"><li id="dds_api_0024__li75281433191813">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0024__table177972282917" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0024__row42371291916"><th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_0024__p112375292099">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_0024__p1723719299916">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_0024__p12237102917913">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_0024__p17501738427">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0024__row16237132913918"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0024__p1723716297918">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0024__p132373291296">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0024__p4793147135010">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0024__p112376297914">Specifies detailed information about the volume request. For more information, see <a href="#dds_api_0024__table3840102812918">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0024__table3840102812918"></a><a name="table3840102812918"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0024__table3840102812918" frame="border" border="1" rules="all"><caption><b>Table 3 </b>volume field data structure description</caption><thead align="left"><tr id="dds_api_0024__row18237529094"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dds_api_0024__p152379292917">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dds_api_0024__p6651023359">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dds_api_0024__p623702916918">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.51485148514851%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dds_api_0024__p1294020412216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0024__row32374291195"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0024__p16237029996">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0024__p616075719302">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0024__p182371929394">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0024__p468875817279">Specifies the role ID.</p>
|
|
<ul id="dds_api_0024__ul10688185812710"><li id="dds_api_0024__li176882581270">For a cluster instance, this parameter is set to the ID of the shard group.</li><li id="dds_api_0024__li12532171917283">This parameter is not transferred for replica set and single node instances.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0024__row11237102919919"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0024__p1435145916299">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0024__p1615821120194">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0024__p8237229896">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0024__p111584308355">Specifies the requested disk capacity. The value must be an integer multiple of 10 and greater than the current storage space.</p>
|
|
<ul id="dds_api_0024__ul15160193083515"><li id="dds_api_0024__li616133010358">In a cluster instance, this parameter indicates the storage space of shard nodes. The value range is from 10 GB to 2000 GB.</li><li id="dds_api_0024__li1016318305356">In a replica set instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 2000 GB.</li><li id="dds_api_0024__li5167113015355">In a single node instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 1000 GB.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0024__ul8838637181818"><li id="dds_api_0024__li683819379181">Example request<p id="dds_api_0024__p116004342017"><a name="dds_api_0024__li683819379181"></a><a name="li683819379181"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge-volume</p>
|
|
<div class="p" id="dds_api_0024__p069214336012">Clusters:<pre class="codeblock" id="dds_api_0024__codeblock1969211331501">{
|
|
"volume":
|
|
{
|
|
"group_id":"1b0c008adbcb495c81a3d5762a02a2abgr02",
|
|
"size":20
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="dds_api_0024__p1369312331108">Replica sets:<pre class="codeblock" id="dds_api_0024__codeblock15693153314014">{
|
|
"volume":
|
|
{
|
|
"size":20
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="dds_api_0024__p2069310335013">Single nodes:<pre class="codeblock" id="dds_api_0024__codeblock4693123315015">{
|
|
"volume":
|
|
{
|
|
"size":20
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0024__section169571128993"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0024__ul142391229794"><li id="dds_api_0024__li623915291399">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0024__table1696717281297" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0024__row1523962918919"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0024__p1923918292913">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0024__p192392029694">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0024__p35841466210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0024__row1023915294916"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0024__p1723932920915">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0024__p1323915298916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0024__p11239729294">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dds_api_0024__li623972915914">Response example<pre class="codeblock" id="dds_api_0024__codeblock22391129498">{
|
|
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0024__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0024__en-us_topic_0000001387505349_p16131712193312">Status Code:202.</p>
|
|
<p id="dds_api_0024__en-us_topic_0000001387505349_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0024__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0024__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|