forked from docs/doc-exports
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>
119 lines
9.8 KiB
HTML
119 lines
9.8 KiB
HTML
<a name="rds_06_0001"></a><a name="rds_06_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying Version Information About a DB Engine</h1>
|
|
<div id="body1545296199187"><div class="section" id="rds_06_0001__section61759636"><h4 class="sectiontitle">Function</h4><p id="rds_06_0001__p33831530">This API is used to query the database version information of a specified DB engine.</p>
|
|
<ul id="rds_06_0001__ul12259155218373"><li id="rds_06_0001__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_06_0001__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_06_0001__section18965813"><h4 class="sectiontitle">URI</h4><ul id="rds_06_0001__ul55999443"><li id="rds_06_0001__li34232944">URI format<p id="rds_06_0001__p39661040"><a name="rds_06_0001__li34232944"></a><a name="li34232944"></a>GET https://{<em id="rds_06_0001__i1539782410157">Endpoint</em>}/v3/{<em id="rds_06_0001__i174825745118">project_id</em>}/datastores/{<em id="rds_06_0001__i6652155355119">database_name</em>}</p>
|
|
</li><li id="rds_06_0001__li21405046">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0001__table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0001__row1482002"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_06_0001__p52933326"><strong id="rds_06_0001__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_06_0001__p59740974"><strong id="rds_06_0001__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_06_0001__p7180698"><strong id="rds_06_0001__b1712611151775">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0001__row44765691"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_06_0001__p2142393">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_06_0001__p39316155">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_06_0001__p1434580163733">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_06_0001__p149071611472">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_0001__row5992637"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_06_0001__p15641626">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_06_0001__p59012183">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_06_0001__p26952636163519">Specifies the DB engine. Its value can be any of the following and is case-insensitive:</p>
|
|
<ul id="rds_06_0001__ul924933143511"><li id="rds_06_0001__li1195974113511">MySQL</li><li id="rds_06_0001__li2014417783511">PostgreSQL</li><li id="rds_06_0001__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_06_0001__section36474591"><h4 class="sectiontitle">Request</h4><ul id="rds_06_0001__ul1183180183717"><li id="rds_06_0001__li1283110163719">Request parameters<p id="rds_06_0001__p848415163614"><a name="rds_06_0001__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_06_0001__ul20324172413497"><li id="rds_06_0001__li4411135064210">Example<p id="rds_06_0001__p1454414211213"><a name="rds_06_0001__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/mysql</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_06_0001__section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_06_0001__ul66273227"><li id="rds_06_0001__li59588135">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0001__table29752153" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0001__row62070345"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_06_0001__p61642077"><strong id="rds_06_0001__b10677139151116">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.62376237623762%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_06_0001__p26952341"><strong id="rds_06_0001__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_06_0001__p35656026"><strong id="rds_06_0001__b650871261115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0001__row2456979"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_06_0001__p64797609">dataStores</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.62376237623762%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_06_0001__a9a9492e05cb648e885d1e747a339d04d">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_06_0001__p22140377">Indicates the list of database versions.</p>
|
|
<p id="rds_06_0001__p1573113732216">For details, see <a href="#rds_06_0001__table66531170">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_06_0001__table66531170"></a><a name="table66531170"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0001__table66531170" frame="border" border="1" rules="all"><caption><b>Table 3 </b>dataStores field data structure description</caption><thead align="left"><tr id="rds_06_0001__row12984378"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_06_0001__p45101667"><strong id="rds_06_0001__b954223110115">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_06_0001__p29356372"><strong id="rds_06_0001__b547253261112">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_06_0001__p29055926"><strong id="rds_06_0001__b203161339113">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0001__row4719792"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0001__p46758891">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0001__p29373839">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0001__p30470722">Indicates the database version ID. Its value is unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_06_0001__row5801050"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_06_0001__p123050">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_06_0001__p9967070">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_06_0001__p2026335">Indicates the database version number. Only the major version number (two digits) is returned. For example, if the version number is MySQL 5.6.X, only 5.6 is returned.</p>
|
|
<p id="rds_06_0001__p153851450162214"></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_06_0001__ul26818564"><li id="rds_06_0001__li40040492">Example normal response<pre class="codeblock" id="rds_06_0001__codeblock9476195315504">{
|
|
"dataStores": [{
|
|
"id": "87620726-6802-46c0-9028-a8785e1f1921",
|
|
"name": "8.0"
|
|
}, {
|
|
"id": "87620726-6802-46c0-9028-a8785e1f1922",
|
|
"name": "5.7"
|
|
}, {
|
|
"id": "e8a8b8cc-63f8-4fb5-8d4a-24c502317a62",
|
|
"name": "5.6"
|
|
}]
|
|
}</pre>
|
|
</li><li id="rds_06_0001__li14211124529">Abnormal response<p id="rds_06_0001__en-us_topic_0224329858_p014165512396"><a name="rds_06_0001__li14211124529"></a><a name="li14211124529"></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_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_06_0001__en-us_topic_0032347778_ul7858132212142"><li id="rds_06_0001__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_06_0001__en-us_topic_0032347778_p1040982941020"><a name="rds_06_0001__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_06_0001__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_06_0001__en-us_topic_0032347778_p0723374409"><a name="rds_06_0001__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_06_0001__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_06_0001__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>
|
|
|