forked from docs/doc-exports
Wang , Deng Ke
5208dcae7b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
167 lines
15 KiB
HTML
167 lines
15 KiB
HTML
<a name="rds_06_0002"></a><a name="rds_06_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying Database Specifications</h1>
|
|
<div id="body1545296199187"><div class="section" id="rds_06_0002__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_06_0002__p52780252141331">This API is used to query the database specifications of a specified DB engine version.</p>
|
|
<ul id="rds_06_0002__ul12259155218373"><li id="rds_06_0002__en-us_topic_0032347778_li1475214752813">Learn how to <a href="rds_03_0001.html">authorize and authenticate</a> this API before using it.</li><li id="rds_06_0002__en-us_topic_0032347778_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_06_0002__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_06_0002__ul53354139141429"><li id="rds_06_0002__li1270098217262">URI format<p id="rds_06_0002__p66079617141421"><a name="rds_06_0002__li1270098217262"></a><a name="li1270098217262"></a>GET https://{<em id="rds_06_0002__i86129260155">Endpoint</em>}/v3/{project_id}/flavors/{database_name}?version_name={version_name}</p>
|
|
</li><li id="rds_06_0002__li4411135064210">Example<p id="rds_06_0002__p1454414211213"><a name="rds_06_0002__li4411135064210"></a><a name="li4411135064210"></a>https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors/mysql?version_name=5.7</p>
|
|
</li></ul>
|
|
<ul id="rds_06_0002__ul49831254144655"><li id="rds_06_0002__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0002__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_06_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_06_0002__p34889605"><strong id="rds_06_0002__b1836614023310">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_06_0002__p7485743"><strong id="rds_06_0002__b1273274016330">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_06_0002__p2365466"><strong id="rds_06_0002__b491164163315">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0002__row57385070"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_06_0002__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_06_0002__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_06_0002__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_06_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_06_0002__row2864326155157"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_06_0002__p41557789155220">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_06_0002__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_06_0002__p64450739155220">Specifies the DB engine name. Its value can be any of the following and is case-insensitive:</p>
|
|
<ul id="rds_06_0002__ul924933143511"><li id="rds_06_0002__li1195974113511">MySQL</li><li id="rds_06_0002__li2014417783511">PostgreSQL</li><li id="rds_06_0002__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row4161445171"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_06_0002__p516110417170">version_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_06_0002__p116114111716">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_06_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>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row115971435205310"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_06_0002__p1959723516537">spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_06_0002__p105971935105319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_06_0002__p10597235155311">Specifies the specification code.</p>
|
|
<div class="notice" id="rds_06_0002__note4969759191412"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="rds_06_0002__p0969155921414">Only DB instances running Microsoft SQL Server 2017 EE support the creation of read replicas. Microsoft SQL Server 2017 EE does not support the creation of single DB instances.</p>
|
|
</div></div>
|
|
<p id="rds_06_0002__p86678172112">The format of the specification code is: {<em id="rds_06_0002__i126668122115">spec code</em>}{<em id="rds_06_0002__i196617832114">instance mode</em>}.</p>
|
|
<ul id="rds_06_0002__ul24442061515"><li id="rds_06_0002__li105302024192113"><em id="rds_06_0002__i35334240217">spec code</em> can be obtained from <a href="rds_10_0004.html#rds_10_0004__ted9b9d433c8a4c52884e199e17f94479">Table 1</a>.</li><li id="rds_06_0002__li1095921282110"><em id="rds_06_0002__i9410114261817">instance mode</em> can be any of the following:<ul id="rds_06_0002__ul07451328162117"><li id="rds_06_0002__li1444664510">For single DB instances, the value is <strong id="rds_06_0002__b105131586157">null</strong>. Example spe_code: rds.mysql.s1.xlarge</li><li id="rds_06_0002__li239415197519">For primary/standby DB instances, the value is <span class="parmvalue" id="rds_06_0002__parmvalue05973377819"><b>.ha</b></span>. Example spe_code: rds.mysql.s1.xlarge.ha</li><li id="rds_06_0002__li132621955572">For read replicas, the value is <span class="parmvalue" id="rds_06_0002__parmvalue17579173418816"><b>.rr</b></span>. Example spe_code: rds.mysql.s1.xlarge.rr</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_06_0002__section36474591"><h4 class="sectiontitle">Request</h4><p id="rds_06_0002__p56327989">None</p>
|
|
</div>
|
|
<div class="section" id="rds_06_0002__section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_06_0002__ul66273227"><li id="rds_06_0002__li59588135">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0002__table29752153" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0002__row62070345"><th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_06_0002__p61642077"><strong id="rds_06_0002__b12952446193514">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.07%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_06_0002__p26952341"><strong id="rds_06_0002__b1660114793511">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_06_0002__p35656026"><strong id="rds_06_0002__b8477174833518">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0002__row2456979"><td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_06_0002__p64797609">flavors</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.07%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_06_0002__p158510360232">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_06_0002__p22140377">Indicates the DB instance specifications information list.</p>
|
|
<p id="rds_06_0002__p16922658102215">For details, see <a href="#rds_06_0002__table66531170">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_06_0002__table66531170"></a><a name="table66531170"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0002__table66531170" frame="border" border="1" rules="all"><caption><b>Table 3 </b>flavors field data structure description</caption><thead align="left"><tr id="rds_06_0002__row12984378"><th align="left" class="cellrowborder" valign="top" width="17.419999999999998%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_06_0002__p45101667"><strong id="rds_06_0002__b186891113615">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.34%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_06_0002__p29356372"><strong id="rds_06_0002__b14880101113614">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.24%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_06_0002__p29055926"><strong id="rds_06_0002__b536521263611">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0002__row4719792"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0002__p95609428242">vcpus</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0002__p29373839">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.24%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0002__p30470722">Indicates the CPU size. For example, the value <strong id="rds_06_0002__b1311053793611">1</strong> indicates 1 vCPU.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row5801050"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0002__p32321902251">ram</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0002__p9967070">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.24%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0002__p175975912613">Indicates the memory size in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row18237015"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0002__p803253">spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0002__p65063572">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.24%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0002__p14244105293416">Indicates the resource specification code. Use <strong id="rds_06_0002__b108281149135817">rds.mysql.m1.xlarge.rr</strong> as an example.</p>
|
|
<ul id="rds_06_0002__ul12216011105918"><li id="rds_06_0002__li17532732205918"><span class="parmvalue" id="rds_06_0002__parmvalue136353217115"><b>rds</b></span>: indicates the RDS product.</li><li id="rds_06_0002__li78965369590"><span class="parmvalue" id="rds_06_0002__parmvalue0715115813017"><b>mysql</b></span>: indicates the DB engine.</li><li id="rds_06_0002__li67861044115915"><span class="parmvalue" id="rds_06_0002__parmvalue7179568013"><b>m1.xlarge</b></span>: indicates the high memory performance specifications.</li><li id="rds_06_0002__li42163115595"><span class="parmvalue" id="rds_06_0002__parmvalue138931811171118"><b>rr</b></span>: indicates the read replica (<span class="parmvalue" id="rds_06_0002__parmvalue48932111115"><b>.ha</b></span> indicates primary/standby DB instances).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row821651732516"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0002__p12168175255">instance_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0002__p621615176251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.24%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0002__p227871816573">Indicates the DB instance type. Its value can be any of the following:</p>
|
|
<ul id="rds_06_0002__ul1328613207570"><li id="rds_06_0002__li1780142295719"><strong id="rds_06_0002__b94633131255">ha</strong>: indicates primary/standby DB instances.</li><li id="rds_06_0002__li174502515571"><strong id="rds_06_0002__b72493481257">replica</strong>: indicates read replicas.</li><li id="rds_06_0002__li142861620145717"><strong id="rds_06_0002__b1497352268">single</strong>: indicates single DB instances.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0002__row13887256172319"><td class="cellrowborder" valign="top" width="17.419999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0002__p722175112411">az_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0002__p12213514242">Map<String, String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.24%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0002__p172295182411">Indicates the status of the AZ to which the DB instance specifications belong. Its value can be any of the following:</p>
|
|
<ul id="rds_06_0002__ul192219516243"><li id="rds_06_0002__li8221653246"><strong id="rds_06_0002__b748045614206">normal</strong>: indicates that the AZ is on sale.</li><li id="rds_06_0002__li14228518249"><strong id="rds_06_0002__b20762105382319">unsupported</strong>: indicates that the DB instance specifications are not supported by the AZ.</li><li id="rds_06_0002__li7221558243"><strong id="rds_06_0002__b842352706154546">sellout</strong>: indicates that the DB instance specifications are sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_06_0002__ul26818564"><li id="rds_06_0002__li40040492">Example normal response<pre class="codeblock" id="rds_06_0002__codeblock29711301984">{
|
|
"flavors": [{
|
|
"vcpus": "1",
|
|
"ram": 2,
|
|
"spec_code": "rds.mysql.c2.medium.ha",
|
|
"instance_mode": "ha",
|
|
"az_status": {
|
|
"az1": "normal",
|
|
"az2": "normal"
|
|
}
|
|
}, {
|
|
"vcpus": "1",
|
|
"ram": 2,
|
|
"spec_code": "rds.mysql.c2.medium.rr",
|
|
"instance_mode": "replica",
|
|
"az_status": {
|
|
"az1": "normal",
|
|
"az2": "normal"
|
|
}
|
|
}]
|
|
}</pre>
|
|
</li><li id="rds_06_0002__li33014451514">Abnormal response<p id="rds_06_0002__en-us_topic_0224329858_p014165512396"><a name="rds_06_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_06_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="rds_06_0002__en-us_topic_0224329858_p0723374409">For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="rds_06_0002__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="rds_06_0002__en-us_topic_0224329858_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>
|
|
|