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>
168 lines
14 KiB
HTML
168 lines
14 KiB
HTML
<a name="smn_api_510002"></a><a name="smn_api_510002"></a>
|
|
|
|
<h1 class="topictitle1">Querying the SMN API v2 Version</h1>
|
|
<div id="body1538011519912"><div class="section" id="smn_api_510002__en-us_topic_0118694332_section46354700"><h4 class="sectiontitle">Description</h4><ul id="smn_api_510002__en-us_topic_0118694332_ul23881051"><li id="smn_api_510002__en-us_topic_0118694332_li13602870">API name<p id="smn_api_510002__en-us_topic_0118694332_p55316967"><a name="smn_api_510002__en-us_topic_0118694332_li13602870"></a><a name="en-us_topic_0118694332_li13602870"></a>QueryV2ApiInfo</p>
|
|
</li><li id="smn_api_510002__en-us_topic_0118694332_li28090655">Function<p id="smn_api_510002__en-us_topic_0118694332_p51489303"><a name="smn_api_510002__en-us_topic_0118694332_li28090655"></a><a name="en-us_topic_0118694332_li28090655"></a>Query the SMN API v2 version information.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510002__en-us_topic_0118694332_section14539121"><h4 class="sectiontitle">URI</h4><ul id="smn_api_510002__en-us_topic_0118694332_ul9883987"><li id="smn_api_510002__en-us_topic_0118694332_li21847026">URI format<p id="smn_api_510002__en-us_topic_0118694332_p62405508"><a name="smn_api_510002__en-us_topic_0118694332_li21847026"></a><a name="en-us_topic_0118694332_li21847026"></a>GET /{api_version}</p>
|
|
</li><li id="smn_api_510002__li277182181111">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510002__table1952532171110" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_510002__row12952113251110"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="smn_api_510002__p13952193220115"><strong id="smn_api_510002__b138181154311">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="smn_api_510002__p18427194911117"><strong id="smn_api_510002__b12478171663117">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="smn_api_510002__p122611473812"><strong id="smn_api_510002__b13620175813412">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="smn_api_510002__p795243271111"><strong id="smn_api_510002__b84235270619115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510002__row1095203271110"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="smn_api_510002__p1395203213111">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="smn_api_510002__p3427164911115">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="smn_api_510002__p12611713812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="smn_api_510002__p695233216116">Version to be queried</p>
|
|
<div class="note" id="smn_api_510002__note6856165481210"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="smn_api_510002__p8856145451214">Currently, only <strong id="smn_api_510002__b19451132516313">v2</strong> is supported.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510002__en-us_topic_0118694332_section63743225"><h4 class="sectiontitle">Request</h4><ul id="smn_api_510002__en-us_topic_0118694332_ul20674614"><li id="smn_api_510002__en-us_topic_0118694332_li50891533">Example request<pre class="screen" id="smn_api_510002__en-us_topic_0118694332_screen55370615">GET https://{SMN_Endpoint}/v2</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_510002__en-us_topic_0118694332_section36818119"><h4 class="sectiontitle">Response</h4><ul id="smn_api_510002__en-us_topic_0118694332_ul55834846"><li id="smn_api_510002__en-us_topic_0118694332_li32751573">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510002__en-us_topic_0118694332_table26328706" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter in the response</caption><thead align="left"><tr id="smn_api_510002__en-us_topic_0118694332_row6366124"><th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="smn_api_510002__en-us_topic_0118694332_p45894015"><strong>Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.762376237623762%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="smn_api_510002__en-us_topic_0118694332_p26427706"><strong>Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.415841584158414%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="smn_api_510002__en-us_topic_0118694332_p60269446"><strong id="smn_api_510002__b1363545675">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510002__en-us_topic_0118694332_row22411503"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="smn_api_510002__en-us_topic_0118694332_p3392477">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="smn_api_510002__p125256566512">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="smn_api_510002__p09481736355">Version information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510002__table219819244718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of the <strong id="smn_api_510002__b842352706162841">version</strong> field</caption><thead align="left"><tr id="smn_api_510002__row1526011204718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="smn_api_510002__p182602274711"><strong>Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="smn_api_510002__p19260192154719"><strong>Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="smn_api_510002__p126017204718"><strong>Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510002__row15260132164715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__p8907105518498">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__p129078554491">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__p88531517575">Version number, for example, <strong id="smn_api_510002__b842352706151910">v2</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510002__row1766313211514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__p1390725544917">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__p13515150155715">Links structure array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__p1785191514575">URL of an API. For details, see <a href="#smn_api_510002__table864210364409">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510002__row826819249365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__en-us_topic_0118694332_p9543622">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__en-us_topic_0118694332_p34835893">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__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_510002__row972024243711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__p2069817541346">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__p1698115415341">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__p1098793361817">Version status, which can be the following:</p>
|
|
<ul id="smn_api_510002__ul1496114571817"><li id="smn_api_510002__li1333120482181"><strong>CURRENT</strong>: widely used version</li><li id="smn_api_510002__li2022155251817"><strong id="smn_api_510002__b3411810173019">SUPPORTED</strong>: earlier version that is still supported</li><li id="smn_api_510002__li896134591819"><strong id="smn_api_510002__b555373110309">DEPRECATED</strong>: deprecated version that may be deleted later</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510002__row79551828143611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__p14902136113515">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__p99021268355">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__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_510002__row17393526173617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="smn_api_510002__p29120166354">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="smn_api_510002__p691191611356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="smn_api_510002__p209171618355">Maximum micro-version number. If the APIs do not support micro-versions, no information will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="smn_api_510002__table864210364409"></a><a name="table864210364409"></a><table cellpadding="4" cellspacing="0" summary="" id="smn_api_510002__table864210364409" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Links structure</caption><thead align="left"><tr id="smn_api_510002__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_510002__smn_api_510001_p115911807403"><strong id="smn_api_510002__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_510002__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_510002__smn_api_510001_p1559111015407"><strong id="smn_api_510002__smn_api_510001_b19775143712019">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_510002__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_510002__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_510002__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_510002__smn_api_510001_p2591150144013">Shortcut link</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_510002__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_510002__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_510002__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_510002__smn_api_510001_p959219013405">Shortcut link marker name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="smn_api_510002__en-us_topic_0118694332_li3766842">Example response<pre class="screen" id="smn_api_510002__en-us_topic_0118694332_screen33901581">{
|
|
"version":
|
|
{
|
|
"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_510002__en-us_topic_0118694332_section62927619"><h4 class="sectiontitle">Returned Value</h4><p id="smn_api_510002__p13638112411919">See <a href="smn_api_63002.html">Returned Value</a>.</p>
|
|
</div>
|
|
<div class="section" id="smn_api_510002__section73211020122511"><h4 class="sectiontitle">Error Codes</h4><p id="smn_api_510002__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>
|
|
|