forked from docs/doc-exports
Ru, Li Yi
9d8047332b
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>
100 lines
9.0 KiB
HTML
100 lines
9.0 KiB
HTML
<a name="rds_05_0027"></a><a name="rds_05_0027"></a>
|
|
|
|
<h1 class="topictitle1">Querying an Autoscaling Policy</h1>
|
|
<div id="body0000001521216833"><div class="section" id="rds_05_0027__section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0027__p1730163110553">This API is used to query the storage autoscaling policy of a DB instance.</p>
|
|
<ul id="rds_05_0027__en-us_topic_0293125646_ul12259155218373"><li id="rds_05_0027__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_0027__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_0027__section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0027__ul1396256192117"><li id="rds_05_0027__li77948231138">This API is only available to RDS for MySQL, Microsoft SQL Server and RDS for PostgreSQL instances whose storage type is cloud SSDs or extreme SSDs and storage space is at least 40 GB.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0027__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0027__ul53354139141429"><li id="rds_05_0027__li1270098217262">URI format<p id="rds_05_0027__p30251930154721"><a name="rds_05_0027__li1270098217262"></a><a name="li1270098217262"></a>GET /v3/{<em id="rds_05_0027__i148911057155316">project_id</em>}/instances/{<em id="rds_05_0027__i923712547">instance_id</em>}/disk-auto-expansion</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0027__ul49831254144655"><li id="rds_05_0027__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0027__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_05_0027__row60083059"><th align="left" class="cellrowborder" valign="top" width="25.82%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_05_0027__p34889605"><strong id="rds_05_0027__b168901413171113">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.599999999999998%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_05_0027__p7485743"><strong id="rds_05_0027__b1360204002617">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.580000000000005%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_05_0027__p2365466"><strong id="rds_05_0027__b4656241102619">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0027__row57385070"><td class="cellrowborder" valign="top" width="25.82%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0027__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0027__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.580000000000005%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0027__p28182251">Project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0027__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_0027__row2864326155157"><td class="cellrowborder" valign="top" width="25.82%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0027__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0027__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.580000000000005%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0027__p64450739155220">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0027__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0027__ul5099287616954"><li id="rds_05_0027__li5628270116954">Parameter description<p id="rds_05_0027__p1221318714"><a name="rds_05_0027__li5628270116954"></a><a name="li5628270116954"></a>None</p>
|
|
</li><li id="rds_05_0027__li4411135064210">URI example<p id="rds_05_0027__p1454414211213"><a name="rds_05_0027__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin011/disk-auto-expansion</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0027__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0027__ul12573920"><li id="rds_05_0027__li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0027__table728825318317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="rds_05_0027__row33722053231"><th align="left" class="cellrowborder" valign="top" width="24.27%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_05_0027__p11799738114718"><strong id="rds_05_0027__b77074131117">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.43%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_05_0027__p879983818477"><strong id="rds_05_0027__b12576151482817">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.300000000000004%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_05_0027__p1799538174710"><strong id="rds_05_0027__b1827241612819">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0027__row1437255316315"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0027__p1037219537319">switch_option</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.43%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0027__p19372253337">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.300000000000004%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0027__p79942101511">Whether autoscaling is enabled.</p>
|
|
<ul id="rds_05_0027__ul6183152612516"><li id="rds_05_0027__li618320261514"><strong id="rds_05_0027__b1252235342818">true</strong>: Enabled.</li><li id="rds_05_0027__li618352675110"><strong id="rds_05_0027__b9547759152818">false</strong>: Disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0027__row8372165310317"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0027__p83728532318">limit_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.43%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0027__p837217531431">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.300000000000004%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0027__p3372105310318">Upper limit for autoscaling, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0027__row1037211532033"><td class="cellrowborder" valign="top" width="24.27%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0027__p2372165315319">trigger_threshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.43%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0027__p1037235310313">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.300000000000004%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0027__p1237255319312">Threshold to trigger autoscaling. If the available storage drops to this threshold or 10 GB, autoscaling is triggered.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0027__ul16665627"><li id="rds_05_0027__li15772917">Example normal response<pre class="codeblock" id="rds_05_0027__codeblock314170531760">{
|
|
"switch_option" : true,
|
|
"limit_size" : 4000,
|
|
"trigger_threshold" : 10
|
|
}</pre>
|
|
</li><li id="rds_05_0027__li68218279114">Abnormal response<p id="rds_05_0027__p28475059"><a name="rds_05_0027__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_0027__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0027__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0027__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0027__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0027__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0027__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0027__en-us_topic_0032347778_p0723374409"><a name="rds_05_0027__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_0027__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0027__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>
|
|
|