forked from docs/doc-exports
Zaoxu, Li
152a7d9381
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com> Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
144 lines
11 KiB
HTML
144 lines
11 KiB
HTML
<a name="smn_api_510001"></a><a name="smn_api_510001"></a>
|
|
|
|
<h1 class="topictitle1">Listing All SMN API Versions</h1>
|
|
<div id="body1538011519912"><div class="section" id="smn_api_510001__en-us_topic_0118694332_section46354700"><h4 class="sectiontitle">Description</h4><ul id="smn_api_510001__en-us_topic_0118694332_ul23881051"><li id="smn_api_510001__en-us_topic_0118694332_li13602870">API name<p id="smn_api_510001__en-us_topic_0118694332_p55316967"><a name="smn_api_510001__en-us_topic_0118694332_li13602870"></a><a name="en-us_topic_0118694332_li13602870"></a>QueryApiSupportVersions</p>
|
|
</li><li id="smn_api_510001__en-us_topic_0118694332_li28090655">Function<p id="smn_api_510001__en-us_topic_0118694332_p51489303"><a name="smn_api_510001__en-us_topic_0118694332_li28090655"></a><a name="en-us_topic_0118694332_li28090655"></a>List all SMN API versions.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510001__en-us_topic_0118694332_section14539121"><h4 class="sectiontitle">URI</h4><ul id="smn_api_510001__en-us_topic_0118694332_ul9883987"><li id="smn_api_510001__en-us_topic_0118694332_li21847026">URI format<p id="smn_api_510001__en-us_topic_0118694332_p62405508"><a name="smn_api_510001__en-us_topic_0118694332_li21847026"></a><a name="en-us_topic_0118694332_li21847026"></a>GET /</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510001__en-us_topic_0118694332_section63743225"><h4 class="sectiontitle">Request</h4><ul id="smn_api_510001__en-us_topic_0118694332_ul20674614"><li id="smn_api_510001__en-us_topic_0118694332_li50891533">Example request<pre class="screen" id="smn_api_510001__screen176501414203310">GET https://{SMN_Endpoint}/</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510001__en-us_topic_0118694332_section36818119"><h4 class="sectiontitle">Response</h4><ul id="smn_api_510001__en-us_topic_0118694332_ul55834846"><li id="smn_api_510001__en-us_topic_0118694332_li32751573">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510001__en-us_topic_0118694332_table26328706" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_510001__en-us_topic_0118694332_row6366124"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_510001__en-us_topic_0118694332_p45894015"><strong>Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_510001__en-us_topic_0118694332_p26427706"><strong>Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_510001__en-us_topic_0118694332_p60269446"><strong id="smn_api_510001__b84235270619115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510001__en-us_topic_0118694332_row22411503"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_510001__en-us_topic_0118694332_p3392477">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_510001__en-us_topic_0118694332_p6355195">Versions structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_510001__p09481736355">Version object list. For details, see <a href="#smn_api_510001__table219819244718">Table 1</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="smn_api_510001__table219819244718"></a><a name="table219819244718"></a><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510001__table219819244718" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Versions structure</caption><thead align="left"><tr id="smn_api_510001__row1526011204718"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="smn_api_510001__p182602274711"><strong id="smn_api_510001__b12444115720445">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="smn_api_510001__p19260192154719"><strong>Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="smn_api_510001__p126017204718"><strong id="smn_api_510001__b33231158134412">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510001__row15260132164715"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__p8907105518498">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__p129078554491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p88531517575">Version number, for example, <strong id="smn_api_510001__b842352706151910">v2</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row826819249365"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__en-us_topic_0118694332_p9543622">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__en-us_topic_0118694332_p34835893">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p7948334354">Minimum micro-version number. If the APIs do not support micro-versions, no information will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row972024243711"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__p2069817541346">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__p1698115415341">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p1098793361817">Version status, which can be the following:</p>
|
|
<ul id="smn_api_510001__ul1496114571817"><li id="smn_api_510001__li1333120482181"><strong id="smn_api_510001__b842352706115252">CURRENT</strong>: widely used version</li><li id="smn_api_510001__li2022155251817"><strong id="smn_api_510001__b19815101718012">SUPPORTED</strong>: earlier version that is still supported</li><li id="smn_api_510001__li896134591819"><strong id="smn_api_510001__b842352706115458">DEPRECATED</strong>: deprecated version that may be deleted later</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row79551828143611"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__p14902136113515">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__p99021268355">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p590215614356">Version release time, which must be UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row17393526173617"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__p29120166354">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__p691191611356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p209171618355">Maximum micro-version number. If the APIs do not support micro-versions, no information will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row926062154712"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510001__p1390725544917">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510001__p13515150155715">Links structure array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510001__p1785191514575">URL of an API. For details, see <a href="#smn_api_510001__table1259118084015">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="smn_api_510001__table1259118084015"></a><a name="table1259118084015"></a><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510001__table1259118084015" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Links structure</caption><thead align="left"><tr id="smn_api_510001__row159118012401"><th align="left" class="cellrowborder" valign="top" width="22.772277227722775%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="smn_api_510001__p115911807403"><strong id="smn_api_510001__b152913357209">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.782178217821784%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="smn_api_510001__p1459115044014"><strong>Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.44554455445545%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="smn_api_510001__p1559111015407"><strong id="smn_api_510001__b19775143712019">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510001__row1459113024020"><td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="smn_api_510001__p175910054015">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="smn_api_510001__p459614402597">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="smn_api_510001__p2591150144013">Shortcut link</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510001__row459130144018"><td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="smn_api_510001__p185911807401">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="smn_api_510001__p856574025910">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="smn_api_510001__p959219013405">Shortcut link marker name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="smn_api_510001__en-us_topic_0118694332_li3766842">Example response<pre class="screen" id="smn_api_510001__en-us_topic_0118694332_screen33901581">{
|
|
"versions": [
|
|
{
|
|
"id": "v2",
|
|
"links": [
|
|
{
|
|
"href": "https://127.0.0.1/v2",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2018-09-19T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510001__en-us_topic_0118694332_section62927619"><h4 class="sectiontitle">Returned Value</h4><p id="smn_api_510001__p13638112411919">See <a href="smn_api_63002.html">Returned Value</a>.</p>
|
|
</div>
|
|
<div class="section" id="smn_api_510001__section73211020122511"><h4 class="sectiontitle">Error Codes</h4><p id="smn_api_510001__p9759142919265">See <a href="smn_api_64000.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="smn_api_510000.html">Version Querying</a></div>
|
|
</div>
|
|
</div>
|
|
|