forked from docs/doc-exports
Dong, Qiu Jian
f5c28c856a
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
192 lines
14 KiB
HTML
192 lines
14 KiB
HTML
<a name="swr_02_0080"></a><a name="swr_02_0080"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body1566521995414"><div class="section" id="swr_02_0080__se03aae4436e64394a95dc13b6f233898"><h4 class="sectiontitle">Function</h4><p id="swr_02_0080__a7005bd3228d34f8ea0fb7b75b17cfbb2">Query all available API versions of SWR.</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__s476df674307e4b04b9545f9575dde042"><h4 class="sectiontitle">URI</h4><p id="swr_02_0080__p3537273892216">GET /</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__s8246d3afdd6f44dc817ce0c3f2ac7d53"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameters</caption><thead align="left"><tr id="swr_02_0080__row16180753121919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="swr_02_0080__p1818415381914">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="swr_02_0080__p518795361914">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="swr_02_0080__p81898532198">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="swr_02_0080__p1519115361914">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__row1418013531199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="swr_02_0080__p15193153141917">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="swr_02_0080__p71967538194">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="swr_02_0080__p181988532198">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="swr_02_0080__p8200653161914">Message body type (format). The value can be <strong id="swr_02_0080__b121666531672226">application/json</strong> or <strong id="swr_02_0080__b98086200572226">charset=utf-8 application/json</strong>.</p>
|
|
<p id="swr_02_0080__p19202853141918">The default value is <strong id="swr_02_0080__b197430751772312">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row4180253141920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="swr_02_0080__p1820485351919">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="swr_02_0080__p16206115318195">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="swr_02_0080__p12208195331916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="swr_02_0080__p121025371911">User token.</p>
|
|
<p id="swr_02_0080__p11212105341920">The token can be obtained by calling an IAM API. The value of <strong id="swr_02_0080__b213727221871422">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__sab9be5ce850743859bb238e072f8d1f2"><h4 class="sectiontitle">Response</h4><ul id="swr_02_0080__ul199945817474"><li id="swr_02_0080__li99942804712">Response parameters<div class="p" id="swr_02_0080__p0383154618611"><a name="swr_02_0080__li99942804712"></a><a name="li99942804712"></a>Status code: 200
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__table1585555623716" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter description</caption><thead align="left"><tr id="swr_02_0080__row18561356203713"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.1.1.2.4.1.1"><p id="swr_02_0080__p20856135619375">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.1.1.2.4.1.2"><p id="swr_02_0080__p3856105610372">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.1.1.2.4.1.3"><p id="swr_02_0080__p6856956203719">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__row18561356173718"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.1.2.4.1.1 "><p id="swr_02_0080__p1985685653718">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.1.2.4.1.2 "><p id="swr_02_0080__p585645612379">Array of <a href="#swr_02_0080__table45446245174724">objects</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.1.2.4.1.3 "><p id="swr_02_0080__p28568564370">A list of objects related to the version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0080__table45446245174724"></a><a name="table45446245174724"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__table45446245174724" frame="border" border="1" rules="all"><caption><b>Table 3 </b>versions parameter description</caption><thead align="left"><tr id="swr_02_0080__row1412623174724"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.1.2.2.4.1.1"><p id="swr_02_0080__p47313663174724">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.1.2.2.4.1.2"><p id="swr_02_0080__p7201512174724">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.1.2.2.4.1.3"><p id="swr_02_0080__p4480706174724">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__row98876365819"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p1440645517302">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p540675519302">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p15406115518308">Version ID (version number), for example, v2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row3367184810392"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p14406755103013">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p17406855153012"><a href="#swr_02_0080__table453717423323">Object</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p13406195533010">API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row626682835815"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p1891845543117">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p1491805516316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p59181855123117">If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row1272510338318"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p69181655183119">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p191855553110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p791815513111">Version status. The options are as follows:</p>
|
|
<ul id="swr_02_0080__ul18609544185011"><li id="swr_02_0080__li160924435017"><strong id="swr_02_0080__b87768175435031">CURRENT</strong>: The version is the primary version.</li><li id="swr_02_0080__li19609194419505"><strong id="swr_02_0080__b38758966635032">SUPPORTED</strong>: The version is an old version, but it is still supported.</li><li id="swr_02_0080__li1260994417506"><strong id="swr_02_0080__b23021817123713">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row11746173743119"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p15919145533117">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p791917552312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p7919195503119">Version release time, which must be the UTC time. For example, the release time of v2 is <strong id="swr_02_0080__b59336354535032">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row14580164713313"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.2.4.1.1 "><p id="swr_02_0080__p791995515312">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.2.4.1.2 "><p id="swr_02_0080__p18919155511315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.2.4.1.3 "><p id="swr_02_0080__p6919195518313">If APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0080__table453717423323"></a><a name="table453717423323"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__table453717423323" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links parameter description</caption><thead align="left"><tr id="swr_02_0080__row1553720421323"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.1.3.2.4.1.1"><p id="swr_02_0080__p1553744263216">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.1.3.2.4.1.2"><p id="swr_02_0080__p15379427326">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.1.3.2.4.1.3"><p id="swr_02_0080__p10537134212325">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__row45372426327"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.3.2.4.1.1 "><p id="swr_02_0080__p9537194253219">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.3.2.4.1.2 "><p id="swr_02_0080__p1753864273219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.3.2.4.1.3 "><p id="swr_02_0080__p2053834210320">Link</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__row125383424322"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.3.2.4.1.1 "><p id="swr_02_0080__p15387424321">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.3.2.4.1.2 "><p id="swr_02_0080__p05381842163219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.3.2.4.1.3 "><p id="swr_02_0080__p5538144212329">Description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</li><li id="swr_02_0080__li11220111113473">Example response<pre class="screen" id="swr_02_0080__screen8405151918172">{
|
|
"versions": [
|
|
{
|
|
"id": "v2",
|
|
"links":
|
|
{
|
|
"href": "https://xxx",
|
|
"rel": "self"
|
|
}
|
|
"min_version": "2.0",
|
|
"status": "CURRENT",
|
|
"updated": "2020-07-09T00:00:00Z",
|
|
"version": "2.26",
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__s336c1dbc7af446a1b3cc077ea3f82fc9"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0080__t33d02fa79e8443868a71c99f411610a5" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0080__r9eb80d64e8f34d0db940daa95fc929dd"><th align="left" class="cellrowborder" valign="top" width="16.439999999999998%" id="mcps1.3.5.2.1.3.1.1"><p id="swr_02_0080__a7e51ed73a71e4dc29d0dd4aae3016632">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="83.56%" id="mcps1.3.5.2.1.3.1.2"><p id="swr_02_0080__aa802d02e21c944f1863435a0d11c7ec1">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0080__r1cc0192c651444db882dde750b14be23"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0080__a6a3639a3cb154e17b95c5076c8036471">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0080__p14504142233912">Request successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0080__r19bdef782c164c93917f897241e521f8"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0080__a7da68e311c0f4267bacf3cbdb71d1ead">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0080__aa6fd12cedd8841e29eeeca27c1bdea1a">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0080__section134071631161117"><h4 class="sectiontitle">Error Codes</h4><p id="swr_02_0080__p15408431161114">For details, see <a href="swr_02_0024.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001471005441.html">API Versions</a></div>
|
|
</div>
|
|
</div>
|
|
|