forked from docs/doc-exports
qiujiandong1
73ffc816f4
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
185 lines
15 KiB
HTML
185 lines
15 KiB
HTML
<a name="swr_02_0080"></a><a name="swr_02_0080"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body8662426"><div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section4528183816014"><h4 class="sectiontitle">Description</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p75281638609">Query all API versions.</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section75291382012"><h4 class="sectiontitle">Constraints</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p1552983814018">None</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section15311038006"><h4 class="sectiontitle">URI</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p453119389011">GET /</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section653112382020"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__en-us_topic_0000001231313911_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameters</caption><thead align="left"><tr id="swr_02_0080__en-us_topic_0000001231313911_row5532133814015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="swr_02_0080__en-us_topic_0000001231313911_p165331383011">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="swr_02_0080__en-us_topic_0000001231313911_p18534193814018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="swr_02_0080__en-us_topic_0000001231313911_p653463815020">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="swr_02_0080__en-us_topic_0000001231313911_p9534203812016">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__en-us_topic_0000001231313911_row205327381404"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p853553813019">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p165356387014">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p15354381012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="swr_02_0080__en-us_topic_0000001231313911_p253573815016">Message body type (format). The value can be <strong id="swr_02_0080__en-us_topic_0000001231313911_b674211151503">application/json</strong> or <strong id="swr_02_0080__en-us_topic_0000001231313911_b474291512011">charset=utf-8 application/json</strong>.</p>
|
|
<p id="swr_02_0080__en-us_topic_0000001231313911_p4535338808">Default value: <strong id="swr_02_0080__en-us_topic_0000001231313911_b1226517271114">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section753710388016"><h4 class="sectiontitle">Response Parameters</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p75373387012"><strong id="swr_02_0080__en-us_topic_0000001231313911_b142066166111031">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__en-us_topic_0000001231313911_response_ListApiVersionsResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="swr_02_0080__en-us_topic_0000001231313911_row16537153817013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="swr_02_0080__en-us_topic_0000001231313911_p15538538808">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="swr_02_0080__en-us_topic_0000001231313911_p12538938902">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="swr_02_0080__en-us_topic_0000001231313911_p453817383012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__en-us_topic_0000001231313911_row25378381105"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1353916381707">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p853913381903">Array of <a href="#swr_02_0080__en-us_topic_0000001231313911_response_VersionDetail">VersionDetail</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p135399381002">List of all versions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0080__en-us_topic_0000001231313911_response_VersionDetail"></a><a name="en-us_topic_0000001231313911_response_VersionDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__en-us_topic_0000001231313911_response_VersionDetail" frame="border" border="1" rules="all"><caption><b>Table 3 </b>VersionDetail</caption><thead align="left"><tr id="swr_02_0080__en-us_topic_0000001231313911_row1554043813017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="swr_02_0080__en-us_topic_0000001231313911_p1254110381008">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="swr_02_0080__en-us_topic_0000001231313911_p1454163811014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="swr_02_0080__en-us_topic_0000001231313911_p15542138808">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__en-us_topic_0000001231313911_row1854018381506"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1854253810020">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p354213814015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p054213387017">Version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row6540133819011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p15542113816010">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p954314381603"><a href="#swr_02_0080__en-us_topic_0000001231313911_response_Link">Link</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p3543123811015">API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row954033819018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p35436382008">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p854415385015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p195441038008">Maximum microversion. If microversions are not supported, the value is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row85401438102"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p125445381204">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p554410381402">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1354415381403">Version status. The value can be:</p>
|
|
<ul id="swr_02_0080__en-us_topic_0000001231313911_ul13666381015"><li id="swr_02_0080__en-us_topic_0000001231313911_li17661312104"><strong id="swr_02_0080__en-us_topic_0000001231313911_b65871016123711">CURRENT</strong>: The version is the primary version.</li><li id="swr_02_0080__en-us_topic_0000001231313911_li1471717551012"><strong id="swr_02_0080__en-us_topic_0000001231313911_b1671161723715">SUPPORTED</strong>: The version is an earlier version, but it is still supported.</li><li id="swr_02_0080__en-us_topic_0000001231313911_li1482320715105"><strong id="swr_02_0080__en-us_topic_0000001231313911_b197516782610444">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row95402388014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1545738701">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1054511388019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p55458386015">Version release time in UTC. For example, the release time of v1 is <strong id="swr_02_0080__en-us_topic_0000001231313911_b160574260810444">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row65401138808"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p11545238106">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1054543810016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p454610381020">Minimum microversion. If microversions are not supported, the value is empty.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0080__en-us_topic_0000001231313911_response_Link"></a><a name="en-us_topic_0000001231313911_response_Link"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__en-us_topic_0000001231313911_response_Link" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Link</caption><thead align="left"><tr id="swr_02_0080__en-us_topic_0000001231313911_row185463381805"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="swr_02_0080__en-us_topic_0000001231313911_p1554743814017">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="swr_02_0080__en-us_topic_0000001231313911_p854793817015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="swr_02_0080__en-us_topic_0000001231313911_p1854783812013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__en-us_topic_0000001231313911_row175461838806"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p654703818019">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p7547143815011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p9548138509">Link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row3546143811018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p185485381007">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p1054810381208">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="swr_02_0080__en-us_topic_0000001231313911_p454818380015">Description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section115487389018"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="swr_02_0080__en-us_topic_0000001231313911_screen954973812013">GET https://{endpoint}</pre>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section65491381407"><h4 class="sectiontitle">Example Response</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p25491138400"><strong id="swr_02_0080__en-us_topic_0000001231313911_b284619877111031">Status code: 200</strong></p>
|
|
<p id="swr_02_0080__en-us_topic_0000001231313911_p0549173811017">Query succeeded.</p>
|
|
<pre class="screen" id="swr_02_0080__en-us_topic_0000001231313911_screen15492381504">{
|
|
"versions" : [ {
|
|
"id" : "v2",
|
|
"links" : {
|
|
"href" : "https://swr-api.xxxx.mycloud.com/v2/",
|
|
"rel" : "self"
|
|
},
|
|
"min_version" : "2.0",
|
|
"status" : "CURRENT",
|
|
"updated" : "2020-07-09T00:00:00Z",
|
|
"version" : "2.26"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section2055118388013"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__en-us_topic_0000001231313911_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0080__en-us_topic_0000001231313911_row14551183811015"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="swr_02_0080__en-us_topic_0000001231313911_p75521838109">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="swr_02_0080__en-us_topic_0000001231313911_p455212385012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__en-us_topic_0000001231313911_row1155143810015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p15528381505">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p165528389013">Query succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__en-us_topic_0000001231313911_row145511638403"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0080__en-us_topic_0000001231313911_p255243816010">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0080__en-us_topic_0000001231313911_p95538381402">Internal error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__en-us_topic_0000001231313911_section855317381904"><h4 class="sectiontitle">Error Codes</h4><p id="swr_02_0080__en-us_topic_0000001231313911_p105531538805">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="swr_02_0089.html">API Versions</a></div>
|
|
</div>
|
|
</div>
|
|
|