forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
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>
153 lines
15 KiB
HTML
153 lines
15 KiB
HTML
<a name="EN-US_TOPIC_0000001917290656"></a><a name="EN-US_TOPIC_0000001917290656"></a>
|
|
|
|
<h1 class="topictitle1">Querying Database Disk Type</h1>
|
|
<div id="body0000001222405632"><div class="section" id="EN-US_TOPIC_0000001917290656__section07031249205913"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290656__p2703114912597">This API is used to query the disk type of a DB instance. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290656__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290656__section6704164945919"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290656__ul6786402367"><li id="EN-US_TOPIC_0000001917290656__li9785407367">URI format<p id="EN-US_TOPIC_0000001917290656__p77049492591"><a name="EN-US_TOPIC_0000001917290656__li9785407367"></a><a name="li9785407367"></a>GET https://{<em id="EN-US_TOPIC_0000001917290656__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode}</p>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul23761135173713"><li id="EN-US_TOPIC_0000001917290656__li73767353371">Example<ul id="EN-US_TOPIC_0000001917290656__ul55571028152810"><li id="EN-US_TOPIC_0000001917290656__li17557102818289">Querying the disk type of a distributed DB instance<p id="EN-US_TOPIC_0000001917290656__en-us_topic_0128427213_p1454414211213"><a name="EN-US_TOPIC_0000001917290656__li17557102818289"></a><a name="li17557102818289"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/storage-type?version=1.4&ha_mode=enterprise</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul173361025105518"><li id="EN-US_TOPIC_0000001917290656__li103361256559">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290656__table13705249205919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290656__row11704949165917"><th align="left" class="cellrowborder" valign="top" width="19.939999999999998%" id="mcps1.3.2.4.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917290656__p1470554995920">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.06%" id="mcps1.3.2.4.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917290656__p15705194975919">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917290656__p870564925910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917290656__p1270514915912">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290656__row16704174916599"><td class="cellrowborder" valign="top" width="19.939999999999998%" headers="mcps1.3.2.4.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290656__p177063490594">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.06%" headers="mcps1.3.2.4.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290656__p19706549135916">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290656__p87061749105918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290656__p1070620492590">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001917290656__p290615610130">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290656__row514845543113"><td class="cellrowborder" valign="top" width="19.939999999999998%" headers="mcps1.3.2.4.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290656__p1569150193210">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.06%" headers="mcps1.3.2.4.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290656__p176911707326">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290656__p86916013213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290656__p46915014321">DB version number. To obtain the DB version number, see <a href="opengauss_newapi_0006.html">Querying DB Engine Versions</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290656__row648494123214"><td class="cellrowborder" valign="top" width="19.939999999999998%" headers="mcps1.3.2.4.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290656__p44871891328">ha_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.06%" headers="mcps1.3.2.4.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290656__p124871399329">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290656__p04877919327">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290656__p154873917322">Instance type. The value can be <strong id="EN-US_TOPIC_0000001917290656__b142101217155718">enterprise</strong> (distributed). It is case-insensitive.</p>
|
|
<p id="EN-US_TOPIC_0000001917290656__p148714913329">Value:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul11487891323"><li id="EN-US_TOPIC_0000001917290656__li1048713943218"><strong id="EN-US_TOPIC_0000001917290656__b848749173217">enterprise</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290656__section8710549185910"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917290656__p178681957183418">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290656__section14713549135910"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290656__ul1989475473812"><li id="EN-US_TOPIC_0000001917290656__li389425411381">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290656__response_StorageTypeListResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290656__row17714949145912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290656__p15714149165917">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290656__p18714124925917">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290656__p187154491591">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290656__row37144498594"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290656__p1171514945914">storage_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290656__p671512493592">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290656__p11715124910593">Storage type information.</p>
|
|
<p id="EN-US_TOPIC_0000001917290656__p19236193115390">For details, see <a href="#EN-US_TOPIC_0000001917290656__response_Storage">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290656__response_Storage"></a><a name="response_Storage"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290656__response_Storage" frame="border" border="1" rules="all"><caption><b>Table 3 </b>storage_type field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290656__row137161549165915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001917290656__p187161649195919">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001917290656__p1671614913598">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001917290656__p571664910597">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290656__row07164492595"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290656__p127174495598">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290656__p1717449195920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290656__p1371710493591">Storage type. Its value can be:</p>
|
|
<p id="EN-US_TOPIC_0000001917290656__p18741566215"><strong id="EN-US_TOPIC_0000001917290656__b10957195711338">ULTRAHIGH</strong>: indicates the SSD.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290656__row671620491592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290656__p471894910592">az_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290656__p1471884914594">map<String, String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290656__p3718154920596"><strong id="EN-US_TOPIC_0000001917290656__b11485565535">key</strong> indicates the AZ ID, and <strong id="EN-US_TOPIC_0000001917290656__b16148165675318">value</strong> indicates the specification status in the AZ. Its value can be any of the following:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul571820498597"><li id="EN-US_TOPIC_0000001917290656__li6718184975913"><strong id="EN-US_TOPIC_0000001917290656__b11351138195415">normal</strong>: on sale.</li><li id="EN-US_TOPIC_0000001917290656__li7718149175916"><strong id="EN-US_TOPIC_0000001917290656__b2016991295414">unsupported</strong>: not supported.</li><li id="EN-US_TOPIC_0000001917290656__li11719144912598"><strong id="EN-US_TOPIC_0000001917290656__b10340131965410">sellout</strong>: sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290656__row67161849105914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290656__p117196490597">support_compute_group_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290656__p1471904995910">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290656__p1571994917597">Performance specifications. Its value can be any of the following:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul77198494592"><li id="EN-US_TOPIC_0000001917290656__li127195493598"><strong id="EN-US_TOPIC_0000001917290656__b85101094194950">normal</strong>: general-enhanced</li><li id="EN-US_TOPIC_0000001917290656__li177201349105912"><strong id="EN-US_TOPIC_0000001917290656__b138333927394950">normal2</strong>: general-enhanced II</li><li id="EN-US_TOPIC_0000001917290656__li1072044975910"><strong id="EN-US_TOPIC_0000001917290656__b8499244145416">armFlavors</strong>: Kunpeng general computing-plus</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917290656__ul11454123104215"><li id="EN-US_TOPIC_0000001917290656__li154541531154217">Example normal response</li></ul>
|
|
<p id="EN-US_TOPIC_0000001917290656__p1263833715428">Database disk types:</p>
|
|
<pre class="codeblock" id="EN-US_TOPIC_0000001917290656__codeblock2058743115015">
|
|
{
|
|
"storage_type": [
|
|
{
|
|
"name": "ULTRAHIGH",
|
|
"az_status": {
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
},
|
|
"support_compute_group_type": [
|
|
"normal",
|
|
"armFlavors",
|
|
"normal2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001917290656__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001917290656__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917290656__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290656__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290656__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290656__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290656__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0013.html">APIs (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|