forked from docs/doc-exports
Dong, Qiu Jian
150bc2026a
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
180 lines
13 KiB
HTML
180 lines
13 KiB
HTML
<a name="swr_02_0081"></a><a name="swr_02_0081"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Specific API Version</h1>
|
|
<div id="body1566521995416"><div class="section" id="swr_02_0081__se03aae4436e64394a95dc13b6f233898"><h4 class="sectiontitle">Function</h4><p id="swr_02_0081__a7005bd3228d34f8ea0fb7b75b17cfbb2">Query a specific API version of SWR.</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0081__s476df674307e4b04b9545f9575dde042"><h4 class="sectiontitle">URI</h4><p id="swr_02_0081__p3537273892216">GET /{<em id="swr_02_0081__i78444774014">api_version</em>}</p>
|
|
<p id="swr_02_0081__p1160013561311">For details about parameters, see <a href="#swr_02_0081__tae82a09e27434bef9a38b734d798ae6c">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0081__tae82a09e27434bef9a38b734d798ae6c"></a><a name="tae82a09e27434bef9a38b734d798ae6c"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0081__tae82a09e27434bef9a38b734d798ae6c" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="swr_02_0081__r2c22eba22439445680961f8c447f8756"><th align="left" class="cellrowborder" valign="top" width="18.41%" id="mcps1.3.2.4.2.5.1.1"><p id="swr_02_0081__a4276374f4f884a1a8ff6eabdab4da030">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.8%" id="mcps1.3.2.4.2.5.1.2"><p id="swr_02_0081__p537522204217">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.2.4.2.5.1.3"><p id="swr_02_0081__p2011016570315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.849999999999994%" id="mcps1.3.2.4.2.5.1.4"><p id="swr_02_0081__en-us_topic_0060210625_p192541611508">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0081__row4140165617213"><td class="cellrowborder" valign="top" width="18.41%" headers="mcps1.3.2.4.2.5.1.1 "><p id="swr_02_0081__p520212400161">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.8%" headers="mcps1.3.2.4.2.5.1.2 "><p id="swr_02_0081__p20379152154213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.2.4.2.5.1.3 "><p id="swr_02_0081__p15117857734">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.849999999999994%" headers="mcps1.3.2.4.2.5.1.4 "><p id="swr_02_0081__p219804051612">API version</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0081__s8246d3afdd6f44dc817ce0c3f2ac7d53"><h4 class="sectiontitle">Request</h4><ul id="swr_02_0081__ul57641153239"><li id="swr_02_0081__li376411510236">Request parameters<p id="swr_02_0081__p15400112132313"><a name="swr_02_0081__li376411510236"></a><a name="li376411510236"></a>N/A</p>
|
|
</li><li id="swr_02_0081__li1278941712231">Example request<pre class="screen" id="swr_02_0081__screen1486125172318">GET https://{Endpoint}/<em id="swr_02_0081__i36546187544">v2</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="swr_02_0081__sab9be5ce850743859bb238e072f8d1f2"><h4 class="sectiontitle">Response</h4><ul id="swr_02_0081__ul965116265542"><li id="swr_02_0081__li7651626155415">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0081__table183801055203619" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter description</caption><thead align="left"><tr id="swr_02_0081__row5381195513365"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="swr_02_0081__p1938145519369">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="swr_02_0081__p6381185513616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="swr_02_0081__p93815559368">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0081__row338165511364"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="swr_02_0081__p1838117551367">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="swr_02_0081__p1438112559365"><a href="#swr_02_0081__table45446245174724">Object</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="swr_02_0081__p4381755113616">A list of objects related to the version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="swr_02_0081__table45446245174724"></a><a name="table45446245174724"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0081__table45446245174724" frame="border" border="1" rules="all"><caption><b>Table 3 </b>version parameter description</caption><thead align="left"><tr id="swr_02_0081__row1412623174724"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="swr_02_0081__p47313663174724">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="swr_02_0081__p7201512174724">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="swr_02_0081__p4480706174724">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0081__row98876365819"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p1440645517302">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p540675519302">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__p15406115518308">Version ID (version number), for example, v2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__row3367184810392"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p14406755103013">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p17406855153012"><a href="#swr_02_0081__table453717423323">Object</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__p13406195533010">API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__row626682835815"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p1891845543117">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p1491805516316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__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_0081__row1272510338318"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p69181655183119">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p191855553110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__p791815513111">Version status. The options are as follows:</p>
|
|
<ul id="swr_02_0081__ul443221519556"><li id="swr_02_0081__li144321015145516"><strong id="swr_02_0081__b2678311953508">CURRENT</strong>: The version is the primary version.</li><li id="swr_02_0081__li134321115155515"><strong id="swr_02_0081__b15180715883508">SUPPORTED</strong>: The version is an old version, but it is still supported.</li><li id="swr_02_0081__li154331815195518"><strong id="swr_02_0081__b23021817123713">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__row11746173743119"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p15919145533117">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p791917552312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__p7919195503119">Version release time, which must be the UTC time. For example, the release time of v2 is <strong id="swr_02_0081__b17189843125813">2018-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__row14580164713313"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="swr_02_0081__p791995515312">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="swr_02_0081__p18919155511315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="swr_02_0081__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_0081__table453717423323"></a><a name="table453717423323"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0081__table453717423323" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links parameter description</caption><thead align="left"><tr id="swr_02_0081__row1553720421323"><th align="left" class="cellrowborder" valign="top" width="21.52215221522152%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="swr_02_0081__p1553744263216">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.65196519651965%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="swr_02_0081__p15379427326">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.825882588258814%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="swr_02_0081__p10537134212325">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0081__row45372426327"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="swr_02_0081__p9537194253219">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="swr_02_0081__p1753864273219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="swr_02_0081__p2053834210320">Link</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__row125383424322"><td class="cellrowborder" valign="top" width="21.52215221522152%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="swr_02_0081__p15387424321">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.65196519651965%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="swr_02_0081__p05381842163219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.825882588258814%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="swr_02_0081__p5538144212329">Description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="swr_02_0081__li164621028125414">Example response<pre class="screen" id="swr_02_0081__screen8405151918172">{
|
|
"version": {
|
|
"id": "v2",
|
|
"links":
|
|
{
|
|
"href": "https://xxx",
|
|
"rel": "self"
|
|
}
|
|
"min_version": "2.0",
|
|
"status": "CURRENT",
|
|
"updated": "2017-12-09T00:00:00Z",
|
|
"version": "2.26"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="swr_02_0081__s336c1dbc7af446a1b3cc077ea3f82fc9"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0081__t33d02fa79e8443868a71c99f411610a5" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0081__r9eb80d64e8f34d0db940daa95fc929dd"><th align="left" class="cellrowborder" valign="top" width="16.439999999999998%" id="mcps1.3.5.2.1.3.1.1"><p id="swr_02_0081__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_0081__aa802d02e21c944f1863435a0d11c7ec1">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0081__r1cc0192c651444db882dde750b14be23"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0081__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_0081__p14504142233912">Request successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0081__r19bdef782c164c93917f897241e521f8"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0081__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_0081__aa6fd12cedd8841e29eeeca27c1bdea1a">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="swr_02_0011.html">API</a></div>
|
|
</div>
|
|
</div>
|
|
|