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_0000002200308556.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

147 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002200308556"></a><a name="EN-US_TOPIC_0000002200308556"></a>
<h1 class="topictitle1">Querying a Specified API Version</h1>
<div id="body0000002200308556"><div class="section" id="EN-US_TOPIC_0000002200308556__section1581531207"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002200308556__p16581183809">This API is used to query a specified API version. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000002200308556__ul924420236520"><li id="EN-US_TOPIC_0000002200308556__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="EN-US_TOPIC_0000002200308556__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_0000002200308556__section19587731300"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002200308556__p3587231018">GET /{version_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002200308556__table135899312012" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000002200308556__row17588113609"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002200308556__p55901431007"><strong id="EN-US_TOPIC_0000002200308556__b176455599111351">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000002200308556__p45906313011"><strong id="EN-US_TOPIC_0000002200308556__b15441421194114">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000002200308556__p105912031207"><strong id="EN-US_TOPIC_0000002200308556__b40482633011352">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000002200308556__p45911733015"><strong id="EN-US_TOPIC_0000002200308556__b201810321911356">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002200308556__row65881331801"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002200308556__p19597731408">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002200308556__p145972314012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002200308556__p16597931409">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002200308556__p3597331709">API version.</p>
<p id="EN-US_TOPIC_0000002200308556__p45981731909"><strong id="EN-US_TOPIC_0000002200308556__b994688810113549">Values</strong>:</p>
<ul id="EN-US_TOPIC_0000002200308556__ul6598531305"><li id="EN-US_TOPIC_0000002200308556__li6598153206">v3</li><li id="EN-US_TOPIC_0000002200308556__li1559815310017">v3.1</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002200308556__section859915313015"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002200308556__p36042315017">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002200308556__section7604183909"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002200308556__p36041432007"><strong id="EN-US_TOPIC_0000002200308556__b1015688999113348">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002200308556__response_TaurusGetSpecificOpenApiVersionRsp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000002200308556__row1860813312016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002200308556__p86081231019"><strong id="EN-US_TOPIC_0000002200308556__b193534608111351">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002200308556__p1060803306"><strong id="EN-US_TOPIC_0000002200308556__b112907762811352">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002200308556__p1560913318011"><strong id="EN-US_TOPIC_0000002200308556__b146841185811356">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002200308556__row1960817312013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p96141631502">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p1661415319012">Array of <a href="#EN-US_TOPIC_0000002200308556__response_OpenApiVersion">OpenApiVersion</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p8614173403">Version details.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002200308556__response_OpenApiVersion"></a><a name="response_OpenApiVersion"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002200308556__response_OpenApiVersion" frame="border" border="1" rules="all"><caption><b>Table 3 </b>OpenApiVersion</caption><thead align="left"><tr id="EN-US_TOPIC_0000002200308556__row116151831004"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002200308556__p5621113508"><strong id="EN-US_TOPIC_0000002200308556__b87667303611351">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_0000002200308556__p19621131104"><strong id="EN-US_TOPIC_0000002200308556__b45548955111352">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_0000002200308556__p762273607"><strong id="EN-US_TOPIC_0000002200308556__b54601592011356">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002200308556__row13615163108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p2062283108">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p062219310010">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p56221331107">Version number, for example, <strong id="EN-US_TOPIC_0000002200308556__b1965934155113530">v3</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002200308556__row3615631209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p176231833014">links</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p11628193601">Array of <a href="#EN-US_TOPIC_0000002200308556__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_0000002200308556__p462923306">API URL.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002200308556__row1261515312010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p1462963603">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p126291731506">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p86291038013">Version status.</p>
<p id="EN-US_TOPIC_0000002200308556__p7629935019"><strong id="EN-US_TOPIC_0000002200308556__b1178960228113549">Values</strong>:</p>
<ul id="EN-US_TOPIC_0000002200308556__ul7629134014"><li id="EN-US_TOPIC_0000002200308556__li196291731109"><strong id="EN-US_TOPIC_0000002200308556__b168859010113611">CURRENT</strong>: The version is the primary version.</li><li id="EN-US_TOPIC_0000002200308556__li0630133801"><strong id="EN-US_TOPIC_0000002200308556__b290535870113623">SUPPORTED</strong>: The version is an earlier version, but it is still supported.</li><li id="EN-US_TOPIC_0000002200308556__li1863020320013"><strong id="EN-US_TOPIC_0000002200308556__b667961396113630">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002200308556__row15615031800"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p1163515312017">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p116351737017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p8636631005">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_0000002200308556__row166158315010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p16636153207">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_0000002200308556__p1863711310017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p1063710310010">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_0000002200308556__response_OpenApiLinks"></a><a name="response_OpenApiLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002200308556__response_OpenApiLinks" frame="border" border="1" rules="all"><caption><b>Table 4 </b>OpenApiLinks</caption><thead align="left"><tr id="EN-US_TOPIC_0000002200308556__row36431238011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000002200308556__p12644131505"><strong id="EN-US_TOPIC_0000002200308556__b55074308711351">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_0000002200308556__p126448319012"><strong id="EN-US_TOPIC_0000002200308556__b193092226611352">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_0000002200308556__p46451931004"><strong id="EN-US_TOPIC_0000002200308556__b81127246911356">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002200308556__row76431232020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p56450313015">href</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p15645939018">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p46491036015">API URL. The value is <strong id="EN-US_TOPIC_0000002200308556__b2138466729113721">""</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002200308556__row10643163803"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002200308556__p36491311014">rel</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002200308556__p13649431400">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002200308556__p146504318015">Its value is <strong id="EN-US_TOPIC_0000002200308556__b657701244113734">self</strong>, indicating that <strong id="EN-US_TOPIC_0000002200308556__b658536965113734">href</strong> is a local link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002200308556__section2651930019"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0000002200308556__p46515316013">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002200308556__section66511318018"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0000002200308556__p1265114316013">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002200308556__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000002200308556__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_0000002200308556__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000002200308556__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