forked from docs/doc-exports
wangdengke2
ee9f8aa0b6
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
203 lines
16 KiB
HTML
203 lines
16 KiB
HTML
<a name="gaussdb_11_0001"></a><a name="gaussdb_11_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying Version Information About a DB Engine</h1>
|
|
<div id="body8662426"><div class="section" id="gaussdb_11_0001__en-us_topic_0000001250985350_section61759636"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p33831530">This API is used to query the version information of a specified DB engine. Before calling this API:</p>
|
|
<ul id="gaussdb_11_0001__en-us_topic_0000001250985350_ul924420236520"><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__en-us_topic_0000001250985350_section18965813"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0001__en-us_topic_0000001250985350_ul55999443"><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li34232944">URI format<p id="gaussdb_11_0001__en-us_topic_0000001250985350_p39661040"><a name="gaussdb_11_0001__en-us_topic_0000001250985350_li34232944"></a><a name="en-us_topic_0000001250985350_li34232944"></a>GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name}</p>
|
|
</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li4411135064210">URI example<p id="gaussdb_11_0001__p166911333175216"><a name="gaussdb_11_0001__en-us_topic_0000001250985350_li4411135064210"></a><a name="en-us_topic_0000001250985350_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql</p>
|
|
</li><li id="gaussdb_11_0001__en-us_topic_0000001250985350_li21405046">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__en-us_topic_0000001250985350_table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0001__en-us_topic_0000001250985350_row1482002"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p52933326"><strong id="gaussdb_11_0001__en-us_topic_0000001250985350_b46257291255">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.91%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p59740974"><strong id="gaussdb_11_0001__en-us_topic_0000001250985350_b4209123002513">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.79%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p7180698"><strong id="gaussdb_11_0001__en-us_topic_0000001250985350_b9625193082517">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__en-us_topic_0000001250985350_row44765691"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p2142393">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p39316155">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.79%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p1434580163733">Project ID of a tenant in a region.</p>
|
|
<p id="gaussdb_11_0001__en-us_topic_0000001250985350_p149071611472">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__en-us_topic_0000001250985350_row5992637"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p15641626">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p59012183">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.79%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="gaussdb_11_0001__en-us_topic_0000001250985350_p773372132113">DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section149941839143411"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__en-us_topic_0000001181402746_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0001__row10994143923420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0001__p1499513913420">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_11_0001__p4995239143412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_11_0001__p14995339153410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_11_0001__p149951399340">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__row1799473911348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0001__p199951039183414">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0001__p1099543911341">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0001__p1499573903415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0001__p299583912348">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__row1299419393348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0001__p99951396347">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0001__p1699693943420">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0001__p39961039163413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0001__p1599613393344">Language.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__row0881721181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0001__p15665114311157">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0001__p36651643101518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0001__p10665443181514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0001__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0001__b148731836112919">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section1489959134414"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0001__p6489459194418"><strong id="gaussdb_11_0001__b107175567296">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__table1648913597446" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="gaussdb_11_0001__row103194023417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0001__p18319403342">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_11_0001__p831405340">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_11_0001__p7334023420">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__row1310400342"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0001__p1241940143413">datastores</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0001__p3414409342">Array of <a href="#gaussdb_11_0001__table8490145919445">MysqlEngineVersionInfo</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0001__p341340113411">DB versions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0001__table8490145919445"></a><a name="table8490145919445"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__table8490145919445" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MysqlEngineVersionInfo</caption><thead align="left"><tr id="gaussdb_11_0001__row15940193419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_11_0001__p25124010348">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_11_0001__p4516409344">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_11_0001__p17515402343">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__row20554020347"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0001__p135104083418">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0001__p45440143419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0001__p9684017343">DB version ID. Its value is unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__row1351440163418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0001__p10654017343">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0001__p136204093411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0001__p26134043418">DB version number. Only the major version number with two digits is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="gaussdb_11_0001__p849114599442"><strong id="gaussdb_11_0001__b1895216118351">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__table19491659164414" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0001__row11491145964417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_11_0001__p549116591446">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_11_0001__p74911959124412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_11_0001__p13491145944414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__row549112593447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0001__p5491145912446">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0001__p154916596442">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0001__p1249175904416">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__row1849120595444"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0001__p9492145994417">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0001__p11492185910449">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0001__p13492105912448">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="gaussdb_11_0001__p349235911443"><strong id="gaussdb_11_0001__b1188683615391">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0001__table34921759134417" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0001__row4492185919440"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_11_0001__p6493959154412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_11_0001__p749385912441">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_11_0001__p149345914444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0001__row249315944415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0001__p44931359164413">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0001__p15493859164415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0001__p3493185911449">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0001__row114931159134417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0001__p1049325917442">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0001__p54931959174415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0001__p144931759174418">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section7964013344"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0001__screen19158151612542">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql</pre>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section13911408341"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0001__p1810144013416"><strong id="gaussdb_11_0001__b2261113413159">Status code: 200</strong></p>
|
|
<p id="gaussdb_11_0001__p13106401347">Success.</p>
|
|
<pre class="screen" id="gaussdb_11_0001__screen61014014348">{
|
|
"datastores" : [ {
|
|
"id" : "87620726-6802-46c0-9028-a8785e1f1921",
|
|
"name" : "8.0"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0001__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0001__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0001__p855716160178">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_11_0000.html">APIs (Unavailable Soon)</a></div>
|
|
</div>
|
|
</div>
|
|
|