yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/taurusdb/api-ref/gaussdb_04_0001.html
wangdengke2 1aae9268b0 taurusdb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-06-17 09:00:31 +00:00

198 lines
14 KiB
HTML
Raw Blame History

<a name="gaussdb_04_0001"></a><a name="gaussdb_04_0001"></a>
<h1 class="topictitle1">Querying Version Information About a DB Engine</h1>
<div id="body1590815684863"><div class="section" id="gaussdb_04_0001__section61759636"><h4 class="sectiontitle">Function</h4><p id="gaussdb_04_0001__p33831530">This API is used to query the version information of a specified DB engine. Before calling this API:</p>
<ul id="gaussdb_04_0001__ul924420236520"><li id="gaussdb_04_0001__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_04_0001__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_04_0001__section13329192064812"><h4 class="sectiontitle">URI</h4><p id="gaussdb_04_0001__p113291520104815">GET /v3/{project_id}/datastores/{database_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__table113361520174811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_04_0001__row53332204485"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_04_0001__p5338132044811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="gaussdb_04_0001__p9339202034811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="gaussdb_04_0001__p143392020174818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="gaussdb_04_0001__p134092084819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row1233416205489"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_04_0001__p5341820124820">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_04_0001__p12341182016487">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_04_0001__p134214209487">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_04_0001__p16160124111206">Project ID of a tenant in a region.</p>
<p id="gaussdb_04_0001__p17160154113209">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_04_0001__row933410206480"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_04_0001__p334217207482">database_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_04_0001__p234362018481">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_04_0001__p18343820144816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_04_0001__p1234472024817">DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0001__section434432024816"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_04_0001__row734552019488"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_04_0001__p63461120114811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_04_0001__p234682034817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_04_0001__p334722034816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_04_0001__p534762020489">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row9345132094810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0001__p203489208489">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_04_0001__p934819209484">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0001__p1634972015484">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0001__p334942054817">User token.</p>
</td>
</tr>
<tr id="gaussdb_04_0001__row334572019482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0001__p33501320154810">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_04_0001__p2035072034816">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0001__p3350320184817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0001__p1635192017487">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0001__section143511201482"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_04_0001__p1351142074813"><strong id="gaussdb_04_0001__b3175173311472">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__response_MysqlEngineVersion" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0001__row15352320164813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_04_0001__p33531320114813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_04_0001__p13353220124812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_04_0001__p5353820154817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row83521920144810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_04_0001__p6353102012486">datastores</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_04_0001__p19354172018489">Array of <a href="#gaussdb_04_0001__response_MysqlEngineVersionInfo">MysqlEngineVersionInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_04_0001__p935442012483">DB versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0001__response_MysqlEngineVersionInfo"></a><a name="response_MysqlEngineVersionInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__response_MysqlEngineVersionInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MysqlEngineVersionInfo</caption><thead align="left"><tr id="gaussdb_04_0001__row14355320184815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_04_0001__p153561120144811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_04_0001__p10356182019486">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_04_0001__p1735716205480">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row1335582094818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0001__p1935714204481">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0001__p93573205483">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0001__p53581120164820">DB version ID. Its value is unique.</p>
</td>
</tr>
<tr id="gaussdb_04_0001__row835515209486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0001__p1435852016485">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0001__p1635820204481">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0001__p10359102017489">DB version number. Only the major version number with two digits is returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0001__p15359102019489"><strong id="gaussdb_04_0001__b761232954812">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0001__row113601520164818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_04_0001__p736112034810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_04_0001__p1036182020488">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_04_0001__p15362122014813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row93601820114812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0001__p14362142019480">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0001__p1736219205486">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0001__p19362172020485">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0001__row20360152020487"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0001__p8363192013482">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0001__p1036392010484">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0001__p13363192084818">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0001__p6363132024812"><strong id="gaussdb_04_0001__b133975441482">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0001__table13364620104810" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0001__row73641520184817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_04_0001__p183661820134815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_04_0001__p33671820124812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_04_0001__p1536762034818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0001__row1436522054812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0001__p836812014819">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0001__p63686202485">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0001__p736852011482">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0001__row173651820124815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0001__p17368142015484">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0001__p16369132064817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0001__p63701820184812">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0001__section123709204482"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_04_0001__screen1527418191918">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql</pre>
</div>
<div class="section" id="gaussdb_04_0001__section1337314207483"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_04_0001__p3374920134816"><strong id="gaussdb_04_0001__b18288131164915">Status code: 200</strong></p>
<p id="gaussdb_04_0001__p5375520194814">Success.</p>
<pre class="screen" id="gaussdb_04_0001__screen637572020487">{
"datastores" : [ {
"id" : "87620726-6802-46c0-9028-a8785e1f1921",
"name" : "8.0"
} ]
}</pre>
</div>
<div class="section" id="gaussdb_04_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_04_0001__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_04_0001__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_04_0001__p19357163913406">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_04_0000.html">APIs (Recommended)</a></div>
</div>
</div>
View Git Blame Copy Permalink