doc-exports/docs/opengauss/api-ref/opengauss_newapi_0006.html
Ru, Li Yi 11c10554c4 gaussdb_api_1128
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>
2024-11-28 19:36:20 +00:00

86 lines
9.2 KiB
HTML

<a name="EN-US_TOPIC_0000001947569485"></a><a name="EN-US_TOPIC_0000001947569485"></a>
<h1 class="topictitle1">Querying DB Engine Versions</h1>
<div id="body0000001275730577"><div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p1779463834710">This API is used to query DB engine versions supported by a DB instance. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>GET https://{<em id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/datastore/versions</p>
</li><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/datastore/versions</p>
</li><li id="EN-US_TOPIC_0000001947569485__li1172351310392">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_table1986313483146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_row158631348151416"><th align="left" class="cellrowborder" valign="top" width="22.79%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p178635485145">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p586384819144">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.330000000000005%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_p3863164871419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569485__row153821619455"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427214_p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427214_p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569485__p19528455451">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001947569485__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0151958051_li387592375220">Parameter description<p id="EN-US_TOPIC_0000001947569485__p16274153113910"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0151958051_li387592375220"></a><a name="en-us_topic_0151958051_li387592375220"></a>None</p>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_ul66972122155"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li569761214151">Example Request<p id="EN-US_TOPIC_0000001947569485__p430044316540"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li569761214151"></a><a name="en-us_topic_0248254028_li569761214151"></a>None</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_section415313301118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_ul48268995"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_li31767774">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_table207147873611" frame="border" border="1" rules="all"><caption><b>Table 2 </b>dataStores field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_row1577020823612"><th align="left" class="cellrowborder" valign="top" width="20.72%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p178613803619">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.82%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p281617863613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.459999999999994%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p98254810367">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_row188358873611"><td class="cellrowborder" valign="top" width="20.72%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p2611995378">versions</p>
</td>
<td class="cellrowborder" valign="top" width="26.82%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p1161892377">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="52.459999999999994%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_p1161169163719">Compatible database versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_ul50009058"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_li47428342">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001947569485__codeblock641693618457">{
"versions": [
"8.103",
"3.223",
"3.222",
"3.208",
"3.103",
"2.7",
"2.3",
"1.4",
"1.0"
]
}</pre>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001947569485__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
</li><li id="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001947569485__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569485__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001947569485__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_newapi_0005.html">DB Engine Versions and Specifications</a></div>
</div>
</div>