forked from docs/doc-exports
Wei, Hongmin
b37b65e78f
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
149 lines
12 KiB
HTML
149 lines
12 KiB
HTML
<a name="en-us_topic_0133313256"></a><a name="en-us_topic_0133313256"></a>
|
|
|
|
<h1 class="topictitle1">Querying the API Versions</h1>
|
|
<div id="body1538032956274"><div class="section" id="en-us_topic_0133313256__section18687215132319"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0133313256__p1161816112319">This API is used to query the versions of all TMS APIs.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313256__section6695141502313"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0133313256__p47416112318">GET /</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313256__section147311515172315"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0133313256__p917934022818">Example request</p>
|
|
<pre class="codeblock" id="en-us_topic_0133313256__codeblock19975123462912"><strong id="en-us_topic_0133313256__b370414152417">GET https://{</strong><em id="en-us_topic_0133313256__i15531261245">TMS endpoint</em><strong id="en-us_topic_0133313256__b083313104242">}/</strong></pre>
|
|
</div>
|
|
<div class="note" id="en-us_topic_0133313256__note616233420511"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"></div></div>
|
|
<div class="section" id="en-us_topic_0133313256__section11732141562320"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0133313256__ul9810161236"><li id="en-us_topic_0133313256__li9851617238">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313256__table17740171518233" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the response</caption><thead align="left"><tr id="en-us_topic_0133313256__row8871619238"><th align="left" class="cellrowborder" valign="top" width="19.848015198480155%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="en-us_topic_0133313256__p28141692310">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.44765523447655%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="en-us_topic_0133313256__p18416152317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.7043295670433%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="en-us_topic_0133313256__p28171614232">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313256__row108191642320"><td class="cellrowborder" valign="top" width="19.848015198480155%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="en-us_topic_0133313256__p88111614232">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.44765523447655%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="en-us_topic_0133313256__p28141622314">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.7043295670433%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="en-us_topic_0133313256__p4873152115617">Specifies all API versions.</p>
|
|
<p id="en-us_topic_0133313256__p68101682312">For details, see <a href="#en-us_topic_0133313256__table374991515234">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133313256__li68101662316"><strong id="en-us_topic_0133313256__b6699296094725">versions</strong> field description
|
|
<div class="tablenoborder"><a name="en-us_topic_0133313256__table374991515234"></a><a name="table374991515234"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313256__table374991515234" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0133313256__row68201612320"><th align="left" class="cellrowborder" valign="top" width="18.87%" id="mcps1.3.5.2.2.2.2.4.1.1"><p id="en-us_topic_0133313256__p281616202313">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.33%" id="mcps1.3.5.2.2.2.2.4.1.2"><p id="en-us_topic_0133313256__p15819166237">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.8%" id="mcps1.3.5.2.2.2.2.4.1.3"><p id="en-us_topic_0133313256__p15861642317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313256__row19861612232"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p9819160233">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p38121612234">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p109181619236">Specifies the version ID, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row1991916122316"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p790163234">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p6991642317">List<Link></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p15951611231">Specifies the API URL.</p>
|
|
<p id="en-us_topic_0133313256__p64911367576">For details, see <a href="#en-us_topic_0133313256__table87796151239">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row16911161237"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p209216142319">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p4931615232">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p59616142317">If the APIs of this version support microversions, set this parameter to the supported latest microversion. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row179131652313"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p5981613232">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p1195169236">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p5352627314210">Specifies the version status.</p>
|
|
<p id="en-us_topic_0133313256__p29448333142119">Possible statuses are as follows:</p>
|
|
<ul id="en-us_topic_0133313256__ul101632012202419"><li id="en-us_topic_0133313256__li1316311128247"><strong id="en-us_topic_0133313256__b842352706192132">CURRENT</strong>: indicates that the version is the primary version.</li><li id="en-us_topic_0133313256__li2308181532419"><strong id="en-us_topic_0133313256__b842352706192150">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="en-us_topic_0133313256__li187211217142418"><strong id="en-us_topic_0133313256__b8542212327">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row2931611231"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p129101614238">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p1391016142310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p174961138125815">Specifies the version release time, which must be the UTC time. For example, the release time of TMS 1.0 is 2016-12-09T00:00:00Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row12971617238"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313256__p29121692313">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p189111692310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p1595167238">If the APIs of this version support microversions, set this parameter to the supported earliest microversion. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133313256__li20961615235"><strong id="en-us_topic_0133313256__b49834808">Links</strong> field description
|
|
<div class="tablenoborder"><a name="en-us_topic_0133313256__table87796151239"></a><a name="table87796151239"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313256__table87796151239" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0133313256__row10941619231"><th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.5.2.3.2.2.4.1.1"><p id="en-us_topic_0133313256__p591816112316">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.87%" id="mcps1.3.5.2.3.2.2.4.1.2"><p id="en-us_topic_0133313256__p7915161233">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.02%" id="mcps1.3.5.2.3.2.2.4.1.3"><p id="en-us_topic_0133313256__p8911652317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313256__row1591116192310"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="en-us_topic_0133313256__p14101016192311">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.87%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="en-us_topic_0133313256__p1710116192319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.02%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="en-us_topic_0133313256__p01031642310">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313256__row7101161237"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="en-us_topic_0133313256__p19101216112319">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.87%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="en-us_topic_0133313256__p1710121612238">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.02%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="en-us_topic_0133313256__p151061632310">self</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0133313256__ul1610181614235"><li id="en-us_topic_0133313256__li1510916112319">Example response<p id="en-us_topic_0133313256__p148073472218"><a name="en-us_topic_0133313256__li1510916112319"></a><a name="li1510916112319"></a><strong id="en-us_topic_0133313256__b76179201440">Status code: 200</strong></p>
|
|
<p id="en-us_topic_0133313256__p1748093410226">Successful operation</p>
|
|
<pre class="screen" id="en-us_topic_0133313256__screen953411316488">{
|
|
"versions": [
|
|
{
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://<em id="en-us_topic_0133313256__i1414163612334">API URL</em>/v1.0"
|
|
}
|
|
],
|
|
"version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2016-12-09T00:00:00Z",
|
|
"min_version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313256__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313256__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313256__section9414853182510"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313256__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</p>
|
|
<p id="en-us_topic_0133313256__p164816210253"></p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0133313255.html">Querying the API Version</a></div>
|
|
</div>
|
|
</div>
|
|
|