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>
211 lines
18 KiB
HTML
211 lines
18 KiB
HTML
<a name="rds_04_0002"></a><a name="rds_04_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Storage Type of a Database</h1>
|
|
<div id="body1568691184460"><div class="section" id="rds_04_0002__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_04_0002__p52780252141331">This API is used to query the storage type of a specified DB engine version.</p>
|
|
<ul id="rds_04_0002__ul12259155218373"><li id="rds_04_0002__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_04_0002__en-us_topic_0240111818_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_04_0002__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_04_0002__ul53354139141429"><li id="rds_04_0002__li1270098217262">URI format<p id="rds_04_0002__p66079617141421"><a name="rds_04_0002__li1270098217262"></a><a name="li1270098217262"></a>GET https://{<em id="rds_04_0002__i86129260155">Endpoint</em>}/v3/{project_id}/storage-type/{database_name}?version_name={version_name}</p>
|
|
</li></ul>
|
|
<ul id="rds_04_0002__ul49831254144655"><li id="rds_04_0002__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_04_0002__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_04_0002__row60083059"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_04_0002__p34889605"><strong id="rds_04_0002__b694113538282">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_04_0002__p7485743"><strong id="rds_04_0002__b2184145516280">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_04_0002__p2365466"><strong id="rds_04_0002__b7124195682817">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_04_0002__row57385070"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_04_0002__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_04_0002__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_04_0002__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_04_0002__p181691757183820">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_04_0002__row2864326155157"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_04_0002__p41557789155220">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_04_0002__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_04_0002__p64450739155220">Specifies the DB engine name. Its value can be any of the following and is case-insensitive:</p>
|
|
<ul id="rds_04_0002__ul924933143511"><li id="rds_04_0002__li1195974113511">MySQL</li><li id="rds_04_0002__li2014417783511">PostgreSQL</li><li id="rds_04_0002__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row4161445171"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_04_0002__p516110417170">version_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_04_0002__p116114111716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_04_0002__p31610414179">Specifies the database version. For details about how to obtain the database version, see section <a href="rds_06_0001.html">Querying Version Information About a DB Engine</a>.</p>
|
|
<ul id="rds_04_0002__ul2128855618558"><li id="rds_04_0002__li532251018558">MySQL databases support 5.6, 5.7, and 8.0.</li><li id="rds_04_0002__li134407134561">PostgreSQL databases support 9.5, 9.6, 10, 11, 12, 13, 14 and 15.</li><li id="rds_04_0002__li7303143151411">Microsoft SQL Server databases only support 2017_SE, 2017_EE, 2019_SE, 2019_EE, 2022_SE and 2022_EE.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_04_0002__section36474591"><h4 class="sectiontitle">Request</h4><ul id="rds_04_0002__ul1183180183717"><li id="rds_04_0002__li1283110163719">Request parameters<p id="rds_04_0002__p848415163614"><a name="rds_04_0002__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_04_0002__ul336417665015"><li id="rds_04_0002__li4411135064210">Example<p id="rds_04_0002__p1454414211213"><a name="rds_04_0002__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/storage-type/mysql?version_name=5.7&ha_mode=ha</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_04_0002__section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_04_0002__ul66273227"><li id="rds_04_0002__li59588135">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_04_0002__table29752153" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_04_0002__row62070345"><th align="left" class="cellrowborder" valign="top" width="19.35%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_04_0002__p61642077"><strong id="rds_04_0002__b1212114317293">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.03%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_04_0002__p26952341"><strong id="rds_04_0002__b3260134412297">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.62%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_04_0002__p35656026"><strong id="rds_04_0002__b3228104562917">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_04_0002__row2456979"><td class="cellrowborder" valign="top" width="19.35%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_04_0002__p64797609">storage_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_04_0002__p158510360232">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_04_0002__p22140377">Indicates the DB instance specifications information list.</p>
|
|
<p id="rds_04_0002__p16922658102215">For details, see <a href="#rds_04_0002__table66531170">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row7292122523418"><td class="cellrowborder" valign="top" width="19.35%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_04_0002__p2083563717347">dsspool_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_04_0002__p083643763418">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_04_0002__p183633713413">Indicates the dsspool specifications information list.</p>
|
|
<p id="rds_04_0002__p1836183743417">For details, see <a href="#rds_04_0002__table1513533533518">Table 4</a>.</p>
|
|
<div class="note" id="rds_04_0002__note12258135143915"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_04_0002__p1575424953620">Only Dedicated Cloud (DeC) users are supported.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_04_0002__table66531170"></a><a name="table66531170"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_04_0002__table66531170" frame="border" border="1" rules="all"><caption><b>Table 3 </b>storage_type field data structure description</caption><thead align="left"><tr id="rds_04_0002__row12984378"><th align="left" class="cellrowborder" valign="top" width="19.63%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_04_0002__p45101667"><strong id="rds_04_0002__b133550517304">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.33%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_04_0002__p29356372"><strong id="rds_04_0002__b14728952123012">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.04%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_04_0002__p29055926"><strong id="rds_04_0002__b17165175443019">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_04_0002__row4719792"><td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_04_0002__p95609428242">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_04_0002__p29373839">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.04%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_04_0002__p18543132117445">Indicates the storage type. Its value can be any of the following:</p>
|
|
<ul id="rds_04_0002__ul97191143171815"><li id="rds_04_0002__rds_01_0002_li17711857191312"><strong id="rds_04_0002__rds_01_0002_b175811447151011">COMMON</strong>: SATA storage.</li><li id="rds_04_0002__rds_01_0002_li1671115572136"><strong id="rds_04_0002__rds_01_0002_b692704062510">ULTRAHIGH</strong>: ultra-high I/O storage.</li><li id="rds_04_0002__rds_01_0002_li882154133612"><strong id="rds_04_0002__rds_01_0002_b962134413123">CLOUDSSD</strong>: cloud SSD storage.</li><li id="rds_04_0002__rds_01_0002_li1186817447711"><strong id="rds_04_0002__rds_01_0002_b16454501416">ESSD</strong>: extreme SSD storage.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row13887256172319"><td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_04_0002__p722175112411">az_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_04_0002__p12213514242">Map<String, String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.04%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_04_0002__p172295182411">Indicates the specification status in an AZ. Its value can be any of the following:</p>
|
|
<ul id="rds_04_0002__ul192219516243"><li id="rds_04_0002__li8221653246"><strong id="rds_04_0002__b14731125581312">normal</strong>: indicates that the specifications in the AZ are available.</li><li id="rds_04_0002__li14228518249"><strong id="rds_04_0002__b14841559191313">unsupported</strong>: indicates that the specifications are not supported by the AZ.</li><li id="rds_04_0002__li7221558243"><strong id="rds_04_0002__b1193011471418">sellout</strong>: indicates that the specifications in the AZ are sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row71092018131315"><td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_04_0002__p1496102012465">support_compute_group_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.33%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_04_0002__p1649610202464">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.04%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_04_0002__p4496202010460">Indicates the performance specifications. Its value can be any of the following:</p>
|
|
<ul id="rds_04_0002__ul153561939163711"><li id="rds_04_0002__rds_06_0002_li193568394374"><strong id="rds_04_0002__rds_06_0002_b6624172703118">normal</strong>: general-enhanced</li><li id="rds_04_0002__rds_06_0002_li649511464416"><strong id="rds_04_0002__rds_06_0002_b15909351193217">general</strong>: general-purpose</li><li id="rds_04_0002__rds_06_0002_li576021120184"><strong id="rds_04_0002__rds_06_0002_b1686961211187">dedicated</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_04_0002__table1513533533518"></a><a name="table1513533533518"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_04_0002__table1513533533518" frame="border" border="1" rules="all"><caption><b>Table 4 </b>dsspool_info field data structure description</caption><thead align="left"><tr id="rds_04_0002__row13135203513512"><th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_04_0002__p72831026368">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.06160616061606%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_04_0002__p1628314243614"><strong id="rds_04_0002__b311861771">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.1958195819582%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_04_0002__p428313213364">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_04_0002__row16136153518355"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_04_0002__p1475410495362">az_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.06160616061606%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_04_0002__p128034493362">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.1958195819582%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_04_0002__p13754184943610">Indicates the name of the AZ where dsspool is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row1713611354357"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_04_0002__p4755149133611">free_capacity_gb</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.06160616061606%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_04_0002__p14755949103619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.1958195819582%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_04_0002__p575574913613">Indicates the available capacity of dsspool.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row1913623511351"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_04_0002__p1775514993614">dsspool_volume_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.06160616061606%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_04_0002__p147550496362">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.1958195819582%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_04_0002__p4755749143620">Indicates the dsspool volume type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row1713763512356"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_04_0002__p167559494368">dsspool_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.06160616061606%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_04_0002__p19755154943616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.1958195819582%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_04_0002__p5756134914364">Indicates the dsspool ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_04_0002__row1620217327364"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_04_0002__p1375664963619">dsspool_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.06160616061606%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_04_0002__p47560493369">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.1958195819582%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_04_0002__p2097612533813">Indicates the dsspool status. Its value can be any of the following:</p>
|
|
<ul id="rds_04_0002__ul1933727123820"><li id="rds_04_0002__li15337579382">available</li><li id="rds_04_0002__li4527121413810">deploying</li><li id="rds_04_0002__li47381217183811">enlarging</li><li id="rds_04_0002__li185291719103819">frozen</li><li id="rds_04_0002__li6598121203817">sellout</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_04_0002__ul26818564"><li id="rds_04_0002__li40040492">Example normal response<pre class="codeblock" id="rds_04_0002__codeblock1631781122611">{
|
|
"storage_type": [{
|
|
"name": "COMMON",
|
|
"az_status": {
|
|
"az1": "normal",
|
|
"az2": "normal",
|
|
},
|
|
"support_compute_group_type": [
|
|
"normal",
|
|
"general",
|
|
"dedicated"
|
|
]
|
|
},
|
|
{
|
|
"name": "ULTRAHIGH",
|
|
"az_status": {
|
|
"az1": "normal",
|
|
"az2": "normal"
|
|
},
|
|
"support_compute_group_type": [
|
|
"normal",
|
|
"general",
|
|
"dedicated"
|
|
]
|
|
}
|
|
]
|
|
"dsspool_info": []
|
|
}</pre>
|
|
</li><li id="rds_04_0002__li33014451514">Abnormal response<p id="rds_04_0002__en-us_topic_0224329858_p014165512396"><a name="rds_04_0002__li33014451514"></a><a name="li33014451514"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_04_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_04_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_04_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_04_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_04_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_04_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_04_0002__en-us_topic_0032347778_p0723374409"><a name="rds_04_0002__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_04_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_04_0002__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="rds_09_0000.html">API v3 (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|