vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_05_0115.html
Ru, Li Yi ec98136450 geminidb_api_20240905 
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-10-09 13:05:44 +00:00

148 lines
11 KiB
HTML
Raw Blame History

<a name="nosql_05_0115"></a><a name="nosql_05_0115"></a>
<h1 class="topictitle1">Querying the Autoscaling Policy of Storage Space</h1>
<div id="body0000001433281949"><div class="section" id="nosql_05_0115__section27131311161815"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0115__p394551161818">This API is used to query the autoscaling policy of storage space.</p>
</div>
<div class="section" id="nosql_05_0115__section177141111111814"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0115__p6693111193510">This API supports the following types of instances:</p>
<ul id="nosql_05_0115__ul6693131110355"><li id="nosql_05_0115__li6693161183510"><span id="nosql_05_0115__text1925615719434">GeminiDB Cassandra</span></li></ul>
</div>
<div class="section" id="nosql_05_0115__section07167114189"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0115__p594611171815">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disk-auto-expansion</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0115__table10717101113182" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0115__row4946121112181"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0115__p119468118189">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_0115__p494651101814">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_0115__p594611114181">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_0115__p13946141111817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0115__row59467119189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0115__p16946131119183">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0115__p179461211121811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0115__p29462119183">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0115__p19946191113181">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_0115__row179464112189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0115__p7946311151811">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0115__p1994616113184">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0115__p18946911111815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0115__p209471211101819">Instance ID, which can be obtained by calling the API described in <a href="nosql_05_0016.html">Querying Instances and Details</a>. If there are no instances available, call the API described in <a href="nosql_05_0014.html">Creating an Instance</a> to create one.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0115__section177301211151814"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0115__table12731101141815" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0115__row894710111185"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0115__p14947141120187">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_0115__p9947141191817">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_0115__p39471311161819">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_0115__p1494712113182">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0115__row99472114181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0115__p2947171191819">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_0115__p17947151115188">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0115__p394761121813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0115__p15947111114182">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0115__section1674031110189"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0115__p13948111161813"><strong id="nosql_05_0115__b11430125212711">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0115__table1074261115183" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0115__row29484113180"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0115__p11948711101815">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_0115__p129481311171815">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_0115__p2948101181811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0115__row12948141118185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0115__p1194861141817">policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0115__p294861171815">object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0115__p994810117184">Autoscaling policy for storage space.</p>
<p id="nosql_05_0115__p1775675191218">No information is returned if the autoscaling policy is disabled.</p>
<p id="nosql_05_0115__p1389011043214">For details, see <a href="#nosql_05_0115__table17759131171816">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0115__table17759131171816"></a><a name="table17759131171816"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0115__table17759131171816" frame="border" border="1" rules="all"><caption><b>Table 4 </b>AutoEnlargePolicy</caption><thead align="left"><tr id="nosql_05_0115__row169482117181"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_05_0115__p1094861161820">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_05_0115__p1948181181815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_05_0115__p6949101116187">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0115__row194916113183"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0115__p694911110181">threshold</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0115__p0949201116185">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0115__p119497113181">Threshold for triggering autoscaling.</p>
</td>
</tr>
<tr id="nosql_05_0115__row17949911111816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0115__p294941171810">step</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0115__p1494914111180">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0115__p194941111184">Percentage increase (step%). When autoscaling is triggered, the database system automatically scales up the current storage space of your instance by step%. If the increased storage space is not a multiple of 10 GB, the system rounds it up to the nearest multiple of 10 GB. The default minimum increment is 100 GB.</p>
</td>
</tr>
<tr id="nosql_05_0115__row49491911171818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0115__p1294901141810">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0115__p139491511101816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0115__p129494111188">Storage limit in GB that autoscaling can increase storage space to.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0115__section159909452049"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0115__ul1283134766"><li id="nosql_05_0115__li3283193419614">URI example<pre class="screen" id="nosql_05_0115__screen122513440710">GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/93e4b3eda14349b1b870f72829bc3b9bin06/disk-auto-expansion</pre>
</li><li id="nosql_05_0115__li4392988710">Example request body<p id="nosql_05_0115__p1641253591613"><a name="nosql_05_0115__li4392988710"></a><a name="li4392988710"></a>None</p>
</li></ul>
</div>
<div class="section" id="nosql_05_0115__section579571111183"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0115__p1095081141817"><strong id="nosql_05_0115__b1393164817014">Status code: 200</strong></p>
<p id="nosql_05_0115__p1695101112181">Success</p>
<pre class="screen" id="nosql_05_0115__screen1595181114189">{
"policy" : {
"threshold" : 90,
"step" : 10,
"size" : 600
}
}</pre>
</div>
<div class="section" id="nosql_05_0115__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0115__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0115__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0115__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>
View Git Blame Copy Permalink