doc-exports/docs/rds/api-ref/en-us_topic_0034943367.html
Wang , Deng Ke 5208dcae7b RDS API 20221104 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-10 09:55:48 +00:00

188 lines
16 KiB
HTML

<a name="en-us_topic_0034943367"></a><a name="en-us_topic_0034943367"></a>
<h1 class="topictitle1">Changing DB Instance Volume</h1>
<div id="body1470368157651"><div class="section" id="en-us_topic_0034943367__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034943367__p3631239417316">This API is used to change the DB instance volume.</p>
</div>
<div class="section" id="en-us_topic_0034943367__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034943367__ul3084351717316"><li id="en-us_topic_0034943367__li915620217316">URI format<p id="en-us_topic_0034943367__p2567371617050"><a name="en-us_topic_0034943367__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/instances/{instanceId}/action</p>
<p id="en-us_topic_0034943367__p3998140515468">Method: POST</p>
</li><li id="en-us_topic_0034943367__li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943367__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.490000000000002%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034943367__p34889605"><strong id="en-us_topic_0034943367__b84235270691445_1">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.88%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034943367__p7485743"><strong id="en-us_topic_0034943367__b842352706102346_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.629999999999995%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034943367__p2365466"><strong id="en-us_topic_0034943367__b842352706163417_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row57385070"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943367__p17679057">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943367__p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943367__p28714935163555">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="en-us_topic_0034943367__row2864326155157"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943367__p41557789155220">instanceId</p>
</td>
<td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943367__p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943367__p7417132564016">Specifies the primary node ID of the DB instance.</p>
<div class="note" id="en-us_topic_0034943367__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0034943367__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0034943367__li61827782155332">Restrictions<ol id="en-us_topic_0034943367__ol51058783111130"><li id="en-us_topic_0034943367__li192051234153816">The adjusted volume size must be greater than the original one and the desired volume size must be a multiple of 10.</li><li id="en-us_topic_0034943367__li44896577111130">The sizes of the primary and standby DB instances are the same. When you scale the primary DB instance, its standby DB instance is also scaled.</li><li id="en-us_topic_0034943367__li29577530115047">The DB instances can be scaled when they are in the <strong id="en-us_topic_0034943367__b842352706163746">Available</strong> state.</li></ol>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034943367__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0034943367__ul5099287616954"><li id="en-us_topic_0034943367__li5628270116954">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943367__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.3.2.1.1.2.4.1.1"><p id="en-us_topic_0034943367__p1204887716954"><strong id="en-us_topic_0034943367__b84235270691445_5">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.544254425442546%" id="mcps1.3.3.2.1.1.2.4.1.2"><p id="en-us_topic_0034943367__p3643495116954"><strong id="en-us_topic_0034943367__b842352706164541_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.1.2.4.1.3"><p id="en-us_topic_0034943367__p6554990116954"><strong id="en-us_topic_0034943367__b842352706163417_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row794180116954"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.3.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943367__p3930611216954">resize</p>
</td>
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.3.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943367__p2967852416954">Dictionary data structure. For details, see <a href="#en-us_topic_0034943367__table634280816954">Table 3</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943367__p3798745816954">Specifies the information about the request parameter <strong id="en-us_topic_0034943367__b842352706113940_1">volume</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034943367__table634280816954"></a><a name="table634280816954"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table634280816954" frame="border" border="1" rules="all"><caption><b>Table 3 </b>resize field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943367__row2197661216954"><th align="left" class="cellrowborder" valign="top" width="23.932393239323936%" id="mcps1.3.3.2.1.2.2.4.1.1"><p id="en-us_topic_0034943367__p3527513616954"><strong id="en-us_topic_0034943367__b84235270691445_7">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.734273427342735%" id="mcps1.3.3.2.1.2.2.4.1.2"><p id="en-us_topic_0034943367__p3871372816954"><strong id="en-us_topic_0034943367__b842352706164541_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.2.2.4.1.3"><p id="en-us_topic_0034943367__p4880423616954"><strong id="en-us_topic_0034943367__b842352706163417_7">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row6082906916954"><td class="cellrowborder" valign="top" width="23.932393239323936%" headers="mcps1.3.3.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943367__p2820759516954">volume</p>
</td>
<td class="cellrowborder" valign="top" width="42.734273427342735%" headers="mcps1.3.3.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943367__p311386916954">Dictionary data structure. For details, see <a href="#en-us_topic_0034943367__table5971833216954">Table 4</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943367__p2900499116954">Specifies the information about the request parameter <strong id="en-us_topic_0034943367__b842352706113940_3">size</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034943367__table5971833216954"></a><a name="table5971833216954"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table5971833216954" frame="border" border="1" rules="all"><caption><b>Table 4 </b>volume field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943367__row3797548116954"><th align="left" class="cellrowborder" valign="top" width="23.932393239323936%" id="mcps1.3.3.2.1.3.2.4.1.1"><p id="en-us_topic_0034943367__p5611509816954"><strong id="en-us_topic_0034943367__b84235270691445_9">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.734273427342735%" id="mcps1.3.3.2.1.3.2.4.1.2"><p id="en-us_topic_0034943367__p4902912116954"><strong id="en-us_topic_0034943367__b842352706164541_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.1.3.2.4.1.3"><p id="en-us_topic_0034943367__p1193582716954"><strong id="en-us_topic_0034943367__b842352706163417_9">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row2727794616954"><td class="cellrowborder" valign="top" width="23.932393239323936%" headers="mcps1.3.3.2.1.3.2.4.1.1 "><p id="en-us_topic_0034943367__p23854016161336">size</p>
</td>
<td class="cellrowborder" valign="top" width="42.734273427342735%" headers="mcps1.3.3.2.1.3.2.4.1.2 "><p id="en-us_topic_0034943367__p5837783016954">Int</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.1.3.2.4.1.3 "><p id="en-us_topic_0034943367__p50035813161416">Specifies the volume size after scaling up. The value must a multiple of 10.</p>
<p id="en-us_topic_0034943367__p168012412563">Its value range is from 50 GB to 4000 GB.</p>
<p id="en-us_topic_0034943367__p8725181468"></p>
<div class="notice" id="en-us_topic_0034943367__note18772920133413"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="en-us_topic_0034943367__p3772920183420">The adjusted volume size of must be greater than or equal to that of the original volume size.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0034943367__ul1041877316954"><li id="en-us_topic_0034943367__li2666010016954">Request example<pre class="codeblock" id="en-us_topic_0034943367__codeblock57848163174212">{
"resize": {
"volume": {
"size": 400
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034943367__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034943367__ul12573920"><li id="en-us_topic_0034943367__li46056421">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table11854613" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943367__row48728718"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034943367__p54712068"><strong id="en-us_topic_0034943367__b84235270691445_11">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.544254425442546%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034943367__p2492560"><strong id="en-us_topic_0034943367__b842352706164541_7">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034943367__p570775"><strong id="en-us_topic_0034943367__b842352706163417_11">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row46232835"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943367__p53872188">extendparam</p>
</td>
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943367__p1571113">Dictionary data structure. For details, see <a href="#en-us_topic_0034943367__table52869820">Table 6</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943367__p4491214">Indicates the returned <strong id="en-us_topic_0034943367__b842352706113519">extendparam</strong> key-value pair.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034943367__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table52869820" frame="border" border="1" rules="all"><caption><b>Table 6 </b>extendparam field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943367__row50931783"><th align="left" class="cellrowborder" valign="top" width="23.932393239323936%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0034943367__p31833731"><strong id="en-us_topic_0034943367__b84235270691445_13">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.734273427342735%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0034943367__p28395444"><strong id="en-us_topic_0034943367__b842352706164541_9">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0034943367__p18329666"><strong id="en-us_topic_0034943367__b842352706163417_13">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row8307988"><td class="cellrowborder" valign="top" width="23.932393239323936%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943367__p1858451">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="42.734273427342735%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943367__p16316838">List data structure. For details, see <a href="#en-us_topic_0034943367__table32267243">Table 7</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943367__p16706408">Indicates the returned <strong id="en-us_topic_0034943367__b5323105162339">jobs</strong> parameter information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034943367__table32267243"></a><a name="table32267243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943367__table32267243" frame="border" border="1" rules="all"><caption><b>Table 7 </b>jobs field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943367__row9230088"><th align="left" class="cellrowborder" valign="top" width="23.75%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0034943367__p9439626"><strong id="en-us_topic_0034943367__b84235270691445_15">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.92%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0034943367__p26412257"><strong id="en-us_topic_0034943367__b842352706164541_11">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0034943367__p59018101"><strong id="en-us_topic_0034943367__b842352706163417_15">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034943367__row15736877"><td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0034943367__p66727538">id</p>
</td>
<td class="cellrowborder" valign="top" width="42.92%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0034943367__p36221483">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0034943367__p48259009">Indicates the task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0034943367__ul16665627"><li id="en-us_topic_0034943367__li15772917">Response example<pre class="codeblock" id="en-us_topic_0034943367__codeblock314170531760">{
"extendparam": {
"jobs": [
{
"id": "2b414788-a600-4883-a023-90e2eb0ea227"
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034943367__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034943367__p28475059">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0016.html">DB Instance Management</a></div>
</div>
</div>