forked from docs/doc-exports
Ru, Li Yi
9457035d64
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>
113 lines
11 KiB
HTML
113 lines
11 KiB
HTML
<a name="rds_05_0028"></a><a name="rds_05_0028"></a>
|
|
|
|
<h1 class="topictitle1">Configuring an Autoscaling Policy</h1>
|
|
<div id="body0000001470817158"><div class="section" id="rds_05_0028__section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0028__p39311723131012">This API is used to configure autoscaling for a DB instance. You will be billed for the added storage.</p>
|
|
<p id="rds_05_0028__p132191533182414">If available storage drops to a specified threshold or 10 GB, your storage will autoscale by 15% (in increments of 10 GB) of your allocated storage.</p>
|
|
<p id="rds_05_0028__p195962011012">Autoscaling up the storage of a read replica does not affect that of the primary instance. The new storage space of the read replica after autoscaling must be no less than that of the primary instance.</p>
|
|
<ul id="rds_05_0028__en-us_topic_0293125646_ul12259155218373"><li id="rds_05_0028__en-us_topic_0293125646_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_05_0028__en-us_topic_0293125646_en-us_topic_0110967248_li1991981933613">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="rds_05_0028__section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0028__ul1396256192117"><li id="rds_05_0028__li77948231138">This API is only available to RDS for MySQL instances whose storage type is cloud SSDs or extreme SSDs and storage space is at least 40 GB.</li><li id="rds_05_0028__li12129185162212">Storage autoscaling is unavailable when the instance is in any of the following statuses: changing instance class, upgrading a minor version, migrating the standby instance, and rebooting.</li><li id="rds_05_0028__li2582183212019">The storage space can be autoscaled up only when your instance status is <strong id="rds_05_0028__b1375116434920">Available</strong> or <strong id="rds_05_0028__b47521349495">Storage full</strong>. The maximum allowed storage is 4,000 GB.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0028__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0028__ul53354139141429"><li id="rds_05_0028__li1270098217262">URI format<p id="rds_05_0028__p30251930154721"><a name="rds_05_0028__li1270098217262"></a><a name="li1270098217262"></a>PUT /v3/{<em id="rds_05_0028__i148911057155316">project_id</em>}/instances/{<em id="rds_05_0028__i923712547">instance_id</em>}/disk-auto-expansion</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0028__ul49831254144655"><li id="rds_05_0028__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0028__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_05_0028__row60083059"><th align="left" class="cellrowborder" valign="top" width="26.279999999999998%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_05_0028__p34889605"><strong id="rds_05_0028__b122651234501">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.729999999999997%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_05_0028__p7485743"><strong id="rds_05_0028__b123102595014">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.989999999999995%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_05_0028__p2365466"><strong id="rds_05_0028__b165179268508">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0028__row57385070"><td class="cellrowborder" valign="top" width="26.279999999999998%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0028__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.729999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0028__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.989999999999995%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0028__p28182251">Project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0028__p14611855135510">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0028__row2864326155157"><td class="cellrowborder" valign="top" width="26.279999999999998%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0028__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.729999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0028__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.989999999999995%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0028__p64450739155220">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0028__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0028__ul5099287616954"><li id="rds_05_0028__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0028__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="rds_05_0028__row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_05_0028__p17490046"><strong id="rds_05_0028__b541521435112">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_05_0028__p7407659"><strong id="rds_05_0028__b723181613519">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_05_0028__p63149496"><strong id="rds_05_0028__b8440181715511">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_05_0028__p14835533"><strong id="rds_05_0028__b155351920511">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0028__row60827539"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0028__p18884326136">switch_option</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0028__p17888143291317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_05_0028__p1388833211315">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_05_0028__p15867135191313">Whether to enable autoscaling.</p>
|
|
<ul id="rds_05_0028__ul1094455810132"><li id="rds_05_0028__li894516585132"><strong id="rds_05_0028__b12121113111291">true</strong>: indicates that autoscaling will be enabled.</li><li id="rds_05_0028__li494595861316"><strong id="rds_05_0028__b851973320297">false</strong>: indicates that autoscaling will be disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0028__row114280134131"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0028__p16888732191318">limit_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0028__p7889163281314">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_05_0028__p588913271310">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_05_0028__p19112150111514">Upper limit for autoscaling, in GB. This parameter is mandatory when <strong id="rds_05_0028__b0416191613585">switch_option</strong> is set to <strong id="rds_05_0028__b6294272585">true</strong>.</p>
|
|
<p id="rds_05_0028__p15889132161314">The value ranges from 40 GB to 4,000 GB and must be no less than the current storage of the instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0028__row16585403499"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0028__p1388919327135">trigger_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0028__p28895322136">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_05_0028__p18891532151311">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_05_0028__p488914324130">Threshold to trigger autoscaling. If the available storage drops to this threshold or 10 GB, autoscaling is triggered. This parameter is mandatory when <strong id="rds_05_0028__b155517141614">switch_option</strong> is set to <strong id="rds_05_0028__b55565141766">true</strong>.</p>
|
|
<p id="rds_05_0028__p388913211139">Enumerated values:</p>
|
|
<ul id="rds_05_0028__ul13889133281314"><li id="rds_05_0028__li68897325137">10</li><li id="rds_05_0028__li1988963261316">15</li><li id="rds_05_0028__li2889163214133">20</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_05_0028__li4411135064210">URI example<p id="rds_05_0028__p1454414211213"><a name="rds_05_0028__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0028__ul18318676175816"><li id="rds_05_0028__li30650356175816">Request example<pre class="codeblock" id="rds_05_0028__codeblock7660181517139">{
|
|
"switch_option" : true,
|
|
"limit_size" : 4000,
|
|
"trigger_threshold" : 10
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0028__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0028__ul16665627"><li id="rds_05_0028__li15772917">Example normal response<p id="rds_05_0028__p53568534518"><a name="rds_05_0028__li15772917"></a><a name="li15772917"></a>None</p>
|
|
</li><li id="rds_05_0028__li68218279114">Abnormal Response<p id="rds_05_0028__p58771023185211"><a name="rds_05_0028__li68218279114"></a><a name="li68218279114"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0028__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0028__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0028__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0028__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0028__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0028__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0028__en-us_topic_0032347778_p0723374409"><a name="rds_05_0028__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0028__section17531128191018"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0028__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|