yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/taurusdb/api-ref/en-us_topic_0000002235229005.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

122 lines
11 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002235229005"></a><a name="EN-US_TOPIC_0000002235229005"></a>
<h1 class="topictitle1">Querying API Versions</h1>
<div id="body0000002235229005"><div class="section" id="EN-US_TOPIC_0000002235229005__section737510319018"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002235229005__p203751232015">This API is used to query API versions. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000002235229005__ul924420236520"><li id="EN-US_TOPIC_0000002235229005__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="EN-US_TOPIC_0000002235229005__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section13376163207"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002235229005__p103771531208">GET /</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section0377733019"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002235229005__p9377937019">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section13377534014"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002235229005__p20377173209"><strong id="EN-US_TOPIC_0000002235229005__b16378103608">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002235229005__response_TaurusGetOpenApiVersionsRsp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response body parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000002235229005__row10378239018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002235229005__p113806310011"><strong id="EN-US_TOPIC_0000002235229005__b6354195911343">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002235229005__p43804313015"><strong id="EN-US_TOPIC_0000002235229005__b34342526349">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.019999999999996%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002235229005__p1938023304"><strong id="EN-US_TOPIC_0000002235229005__b262074163513">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002235229005__row03790320013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p938011313014">versions</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p18381173406">Array of <a href="#EN-US_TOPIC_0000002235229005__response_OpenApiVersion">OpenApiVersion</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p10381637019">Version list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002235229005__response_OpenApiVersion"></a><a name="response_OpenApiVersion"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002235229005__response_OpenApiVersion" frame="border" border="1" rules="all"><caption><b>Table 2 </b>OpenApiVersion</caption><thead align="left"><tr id="EN-US_TOPIC_0000002235229005__row238215311012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002235229005__p73831731209"><strong id="EN-US_TOPIC_0000002235229005__b250116143519">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000002235229005__p1538416316016"><strong id="EN-US_TOPIC_0000002235229005__b18384152163515">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000002235229005__p1384631808"><strong id="EN-US_TOPIC_0000002235229005__b631036173519">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002235229005__row18382931401"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p13842031508">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p14384193803">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p11384831008">Version number, for example, <strong id="EN-US_TOPIC_0000002235229005__b19561813173513">v3</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002235229005__row15382193308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p1038515316017">links</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p23851732011">Array of <a href="#EN-US_TOPIC_0000002235229005__response_OpenApiLinks">OpenApiLinks</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p1238633608">API URL.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002235229005__row7382734019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p03871831602">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p73871231608">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p183871031504">Version status.</p>
<p id="EN-US_TOPIC_0000002235229005__p6387839012"><strong id="EN-US_TOPIC_0000002235229005__b88025468350">Values</strong>:</p>
<ul id="EN-US_TOPIC_0000002235229005__ul1538819310012"><li id="EN-US_TOPIC_0000002235229005__li0388932017"><strong id="EN-US_TOPIC_0000002235229005__b1881417499356">CURRENT</strong>: The version is the primary version.</li><li id="EN-US_TOPIC_0000002235229005__li123881438016"><strong id="EN-US_TOPIC_0000002235229005__b4889201118364">SUPPORTED</strong>: The version is an earlier version, but it is still supported.</li><li id="EN-US_TOPIC_0000002235229005__li153889310016"><strong id="EN-US_TOPIC_0000002235229005__b18867202373610">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002235229005__row113821320010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p1838823009">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p738918319015">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p1438910319011">Version release time in UTC. For example, the release time of v3 is 2020-10-29T03:30:42Z.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002235229005__row1638313606"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p183901831409">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p3390031301">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p8390739012">If the APIs of this version support microversions, the earliest microversion is returned. If not, an empty value is returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002235229005__response_OpenApiLinks"></a><a name="response_OpenApiLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002235229005__response_OpenApiLinks" frame="border" border="1" rules="all"><caption><b>Table 3 </b>OpenApiLinks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002235229005__row143911434018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002235229005__p2392331506"><strong id="EN-US_TOPIC_0000002235229005__b950291203514">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000002235229005__p4392193902"><strong id="EN-US_TOPIC_0000002235229005__b138452123517">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000002235229005__p1939211310016"><strong id="EN-US_TOPIC_0000002235229005__b1531156163510">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002235229005__row1391831010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p173921331102">href</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p14393531608">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p5393433010">API URL. The value is <strong id="EN-US_TOPIC_0000002235229005__b114301811193719">""</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002235229005__row839123602"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002235229005__p9393731108">rel</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002235229005__p539323803">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002235229005__p15394153308">Its value is <strong id="EN-US_TOPIC_0000002235229005__b178807218377">self</strong>, indicating that <strong id="EN-US_TOPIC_0000002235229005__b10880421173718">href</strong> is a local link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section173941435017"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0000002235229005__p93941236018">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section83941031011"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0000002235229005__p639517317015">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000002235229005__gaussdb_04_0001_p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002235229005__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000002235229005__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="en-us_topic_0000002235108869.html">API Version Queries</a></div>
</div>
</div>
View Git Blame Copy Permalink