forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
179 lines
15 KiB
HTML
179 lines
15 KiB
HTML
<a name="EN-US_TOPIC_0000002531893935"></a><a name="EN-US_TOPIC_0000002531893935"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Disk Capacity Expansion Range</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002531893935__section1272485111310"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002531893935__p7725125117315">This API is used to query capacity range that a disk can be expanded to.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1072517511139"><strong id="EN-US_TOPIC_0000002531893935__b197250511635">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1172513515312">Disk capacity expansion can be performed only for cloud data warehouses using SSD or hybrid data warehouses. Only version 8.1.1.203 and later are supported.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section1972510512039"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000002531893935__p137251751331">For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section167252051731"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002531893935__p1972511511835">GET /v1/{project_id}/clusters/{cluster_id}/storage-expand-range</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002531893935__table272611518320" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002531893935__row372510511433"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002531893935__p1472617510316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002531893935__p672695118317">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002531893935__p372611511538">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002531893935__p137265518312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002531893935__row157258511936"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002531893935__p172611511239">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002531893935__p14726751836">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002531893935__p7726751632">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002531893935__p172612511830"><strong id="EN-US_TOPIC_0000002531893935__b127265513313">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p6726125113310">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p11726165118317"><strong id="EN-US_TOPIC_0000002531893935__b11726115118318">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p672619515313">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p167262511232"><strong id="EN-US_TOPIC_0000002531893935__b1972695120319">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p67267516316">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p127264511835"><strong id="EN-US_TOPIC_0000002531893935__b17274515316">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p10727105118313">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row1072585119319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002531893935__p77278511533">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002531893935__p4727175116316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002531893935__p137271351236">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002531893935__p14727145114317"><strong id="EN-US_TOPIC_0000002531893935__b1372716518311">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p67272511234">Cluster ID. For details about how to obtain the value, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p147277511236"><strong id="EN-US_TOPIC_0000002531893935__b187273511932">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1872715515316">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1872718511132"><strong id="EN-US_TOPIC_0000002531893935__b472720511238">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p87271511439">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p872711511132"><strong id="EN-US_TOPIC_0000002531893935__b9727155111310">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1672712511837">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section2727185110315"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002531893935__p4727155118312">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section572785117311"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002531893935__p872714511236"><strong id="EN-US_TOPIC_0000002531893935__b1372885117318">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002531893935__en-us_topic_0000002340937136_response_DiskExpandScopeResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002531893935__row177287515310"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002531893935__p107284515312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000002531893935__p187284516314">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000002531893935__p672816511438">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002531893935__row672865111311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002531893935__p1072815515319">min_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002531893935__p072811517311">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002531893935__p1172885116310"><strong id="EN-US_TOPIC_0000002531893935__b1972895114310">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p18728105113310">Minimum disk capacity of a single node after the expansion, in GB.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1972918515314"><strong id="EN-US_TOPIC_0000002531893935__b67294511633">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p17291851433">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row1072810511334"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002531893935__p972925117310">max_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002531893935__p1572945119311">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002531893935__p16729135116312"><strong id="EN-US_TOPIC_0000002531893935__b127291511038">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p157291351739">Maximum disk capacity of a single node after the expansion, in GB.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p1372914511132"><strong id="EN-US_TOPIC_0000002531893935__b172917511434">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p187290511932">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row1472885110319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002531893935__p107291551030">current_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002531893935__p177296511237">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002531893935__p1472917511936"><strong id="EN-US_TOPIC_0000002531893935__b12729155119311">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p47293518319">Current disk capacity, in GB.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p37296516316"><strong id="EN-US_TOPIC_0000002531893935__b372914511332">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p9729195120310">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row7728105112320"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002531893935__p1672916515318">step</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002531893935__p1672935110310">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002531893935__p187308511231"><strong id="EN-US_TOPIC_0000002531893935__b12730165111315">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p773018511031">How much the disk capacity is expanded at a time, in GB. For example, if the disk capacity of a single node is 20 GB and this parameter is set to <strong id="EN-US_TOPIC_0000002531893935__b137307510315">20</strong>, the disk capacity after the expansion is at least 40 GB.</p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p167301751039"><strong id="EN-US_TOPIC_0000002531893935__b1373018511938">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p373045113310">Greater than or equal to <strong id="EN-US_TOPIC_0000002531893935__b18730851532">10</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section16730125116310"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002531893935__p1673035113316">Query the disk capacity expansion range of the current cluster.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002531893935__screen2730125114312">get https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/storage-expand-range</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section1573016511236"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002531893935__p1573025120318"><strong id="EN-US_TOPIC_0000002531893935__b1173035116316">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000002531893935__p147308511536">The request for expanding the disk capacity is submitted.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002531893935__screen1730195118311">{
|
|
"min_size" : 20,
|
|
"max_size" : 2000,
|
|
"current_size" : 20,
|
|
"step" : 10
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002531893935__section585513519314"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002531893935__en-us_topic_0000002340937136_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002531893935__row1673815511937"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002531893935__p128553511134">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000002531893935__p148555517316">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002531893935__row1773817511032"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p785575119315">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p485519511331">The request for expanding the disk capacity is submitted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row47385519318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p685519511832">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p118557516318">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row3738135110318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p2855251032">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p68552516313">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row77381951437"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p38555511233">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p148553511532">You do not have required permissions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row173845112319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p1285535116319">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p1855651839">No resources found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row1738175114315"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p108551516312">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p14855105120319">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002531893935__row107382517316"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002531893935__p68551511737">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002531893935__p138557513318">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0026.html">Node Change</a></div>
|
|
</div>
|
|
</div>
|
|
|