forked from docs/doc-exports
Wang , Deng Ke
21e968a153
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
163 lines
15 KiB
HTML
163 lines
15 KiB
HTML
<a name="en-us_topic_0032347779"></a><a name="en-us_topic_0032347779"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Specified API Version</h1>
|
|
<div id="body13251620"><div class="section" id="en-us_topic_0032347779__section50404481154838"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0032347779__p56231143154838">This API is used to query the specified API version.</p>
|
|
<ul id="en-us_topic_0032347779__ul12259155218373"><li id="en-us_topic_0032347779__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="en-us_topic_0032347779__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347779__section36318247154838"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0032347779__ul56096891154838"><li id="en-us_topic_0032347779__li35109978154838">URI format<p id="en-us_topic_0032347779__p47554352154838"><a name="en-us_topic_0032347779__li35109978154838"></a><a name="li35109978154838"></a>GET https://{<em id="en-us_topic_0032347779__i1036612119157">Endpoint</em>}/rds/{<em id="en-us_topic_0032347779__i119136911476">versionId</em>}</p>
|
|
</li><li id="en-us_topic_0032347779__li26697326154838">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347779__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347779__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0032347779__p34889605"><strong id="en-us_topic_0032347779__b842352706102328">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.26%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0032347779__p7485743"><strong id="en-us_topic_0032347779__b842352706102346">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.44%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0032347779__p2365466"><strong id="en-us_topic_0032347779__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347779__row29710333152450"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032347779__p54604978152455">versionId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.26%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032347779__p60927123152455">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032347779__p36149969152455">Specifies the API version. It is case-sensitive.</p>
|
|
<p id="en-us_topic_0032347779__p3406227152312">For details, see <span class="parmname" id="en-us_topic_0032347779__parmname6865125310143"><b>id</b></span> in <a href="en-us_topic_0032347778.html#en-us_topic_0032347778__table37479565104653">Table 2</a> in section <a href="en-us_topic_0032347778.html">Querying API Versions</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347779__section47398739154838"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0032347779__ul1183180183717"><li id="en-us_topic_0032347779__li1283110163719">Request parameters<p id="en-us_topic_0032347779__p848415163614"><a name="en-us_topic_0032347779__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0032347779__ul742513617452"><li id="en-us_topic_0032347779__li4411135064210">Example<p id="en-us_topic_0032347779__p1454414211213"><a name="en-us_topic_0032347779__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/rds/v1</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347779__section59724852154838"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0032347779__ul18241230105616"><li id="en-us_topic_0032347779__li28551847105616">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347779__table62971306105515" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032347779__row21185732105515"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0032347779__p19221610105536"><strong id="en-us_topic_0032347779__b842352706102328_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0032347779__p13446610105536"><strong id="en-us_topic_0032347779__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0032347779__p15433610105536"><strong id="en-us_topic_0032347779__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347779__row24371359105515"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347779__p59749643105536">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347779__p7882916105536">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347779__p42392997105536">Indicates the list of detailed API version information.</p>
|
|
<p id="en-us_topic_0032347779__p239763262013">For details, see <a href="#en-us_topic_0032347779__table57914909154838">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347779__row3452848511416"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032347779__p4534392511416">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032347779__p4897932611416">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032347779__p790243911416">Indicates the list of detailed API version information.</p>
|
|
<p id="en-us_topic_0032347779__p54651241172018">For details, see <a href="#en-us_topic_0032347779__table57914909154838">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0032347779__table57914909154838"></a><a name="table57914909154838"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347779__table57914909154838" frame="border" border="1" rules="all"><caption><b>Table 3 </b>versions field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347779__row17905664154838"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0032347779__p41072674154838"><strong id="en-us_topic_0032347779__b842352706102328_2">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0032347779__p38552284154838"><strong id="en-us_topic_0032347779__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0032347779__p35727319154838"><strong id="en-us_topic_0032347779__b842352706163417_2">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347779__row8231739154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347779__p62791086154838">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347779__p52913243154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347779__p58114280154838">Indicates the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347779__row83118291298"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347779__p2684540212911">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347779__p2699394512911">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347779__p1568933512911">Indicates the API version link information. Its value is empty.</p>
|
|
<p id="en-us_topic_0032347779__p13789175472010">For details, see <a href="#en-us_topic_0032347779__table630875915440">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347779__row53266474154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347779__p19617131154838">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347779__p45483744154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347779__p60304625154838">Indicates the version status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347779__row5870720154838"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032347779__p5766344154838">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032347779__p64420704154838">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032347779__p50694512154838">Indicates the version update time.</p>
|
|
<p id="en-us_topic_0032347779__p53597429154838">The format is yyyy-mm-dd Thh:mm:ssZ.</p>
|
|
<p id="en-us_topic_0032347779__p12614817154838"><strong id="en-us_topic_0032347779__b842352706104536">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="en-us_topic_0032347779__b842352706161738">Z</strong> indicates the UTC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0032347779__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032347779__table630875915440" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links field data structure description</caption><thead align="left"><tr id="en-us_topic_0032347779__row4191288815440"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0032347779__p3950073415440"><strong id="en-us_topic_0032347779__b842352706102328_3">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0032347779__p4544288515440"><strong id="en-us_topic_0032347779__b842352706164541_2">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0032347779__p5699506015440"><strong id="en-us_topic_0032347779__b842352706163417_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032347779__row5319717215440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0032347779__p1400369315440">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.800000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0032347779__p6055731815440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0032347779__p619568715440">Indicates the API URL and the value is <strong id="en-us_topic_0032347779__b842352706181135">""</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032347779__row5576118615440"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0032347779__p2036224315440">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.800000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0032347779__p3872902515440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0032347779__p5004333115440">Its value is <strong id="en-us_topic_0032347779__b84235270616818">self</strong>, indicating that <strong id="en-us_topic_0032347779__b84235270616856">href</strong> is a local link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0032347779__ul49821912154838"><li id="en-us_topic_0032347779__li45744025154838">Example normal response<pre class="codeblock" id="en-us_topic_0032347779__codeblock5278200391">{
|
|
"version": {
|
|
"id": "v1",
|
|
"links": [],
|
|
"status": "CURRENT",
|
|
"updated": "2017-02-07T17:34:02Z"
|
|
},
|
|
"versions": {
|
|
"id": "v1",
|
|
"links": [],
|
|
"status": "CURRENT",
|
|
"updated": "2017-02-07T17:34:02Z"
|
|
}
|
|
}</pre>
|
|
</li><li id="en-us_topic_0032347779__li1371185810452">Abnormal response<p id="en-us_topic_0032347779__en-us_topic_0224329858_p014165512396"><a name="en-us_topic_0032347779__li1371185810452"></a><a name="li1371185810452"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347779__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="en-us_topic_0032347779__en-us_topic_0032347778_ul7858132212142"><li id="en-us_topic_0032347779__en-us_topic_0032347778_li58581622171411">Normal<p id="en-us_topic_0032347779__en-us_topic_0032347778_p1040982941020"><a name="en-us_topic_0032347779__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="en-us_topic_0032347779__en-us_topic_0032347778_li11583183218149">Abnormal<p id="en-us_topic_0032347779__en-us_topic_0032347778_p0723374409"><a name="en-us_topic_0032347779__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032347779__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="en-us_topic_0032347779__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887469.html">Obtaining an API Version</a></div>
|
|
</div>
|
|
</div>
|
|
|