forked from docs/doc-exports
Wei, Hongmin
ab04d48074
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>
190 lines
16 KiB
HTML
190 lines
16 KiB
HTML
<a name="en-us_topic_0133313257"></a><a name="en-us_topic_0133313257"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About a Specified TMS API Version</h1>
|
|
<div id="body1538032956274"><div class="section" id="en-us_topic_0133313257__section112333415306"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0133313257__p7380736123018">This API is used to query the details of a specified TMS API version.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313257__section9128153473016"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0133313257__p03801936123018">GET /{api_version}</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313257__section32381034103013"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0133313257__ul5382536133015"><li id="en-us_topic_0133313257__li2120813898">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313257__table12569102910" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request</caption><thead align="left"><tr id="en-us_topic_0133313257__row863915010914"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0133313257__p86399015915">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0133313257__p15639401794">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0133313257__p363930296">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0133313257__p2640101992">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313257__row1864013012915"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0133313257__p1364000890">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0133313257__p146400018913">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0133313257__p9640601896">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.800000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0133313257__p1464011017920">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0133313257__table89081516592"></a><a name="table89081516592"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313257__table89081516592" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="en-us_topic_0133313257__row627664919518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0133313257__p3349526181715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0133313257__p2349182681715">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0133313257__p183491226101712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0133313257__p1734915261172">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313257__row8281649753"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0133313257__p17280349556">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0133313257__p122819492055">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0133313257__p1028110492510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0133313257__p172819491858">Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set <strong id="en-us_topic_0133313257__b1896416521191">scope</strong> to <strong id="en-us_topic_0133313257__b14965652697">domain</strong>. The value of <strong id="en-us_topic_0133313257__b179651521297">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133313257__li123829369302">Example request<pre class="codeblock" id="en-us_topic_0133313257__codeblock991913413312"><strong id="en-us_topic_0133313257__b1476641313306">GET https://{</strong><em id="en-us_topic_0133313257__i1766121318303">TMS endpoint</em><strong id="en-us_topic_0133313257__b1176791314305">}/v1.0</strong></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313257__section17252434193018"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0133313257__ul638211364303"><li id="en-us_topic_0133313257__li13833368302">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313257__table638373419305" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response</caption><thead align="left"><tr id="en-us_topic_0133313257__row163831536143019"><th align="left" class="cellrowborder" valign="top" width="24.83%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0133313257__p1738363612307">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.65%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0133313257__p4383136193010">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.519999999999996%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0133313257__p153838362301">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313257__row163832366304"><td class="cellrowborder" valign="top" width="24.83%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0133313257__p3383133610301">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.65%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0133313257__p2383133616305">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.519999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0133313257__p1238343618301">Specifies the version of a specified API.</p>
|
|
<p id="en-us_topic_0133313257__p041917181204">For details, see <a href="#en-us_topic_0133313257__table7480934143011">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133313257__li63831136143011"><strong id="en-us_topic_0133313257__b1410584514918">version</strong> field description
|
|
<div class="tablenoborder"><a name="en-us_topic_0133313257__table7480934143011"></a><a name="table7480934143011"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313257__table7480934143011" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0133313257__row5383153610309"><th align="left" class="cellrowborder" valign="top" width="18.688131186881314%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="en-us_topic_0133313257__p2384153663010">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.077792220777923%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="en-us_topic_0133313257__p8384203618302">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.23407659234077%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="en-us_topic_0133313257__p17384123612304">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313257__row838413616301"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p638463613305">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p43841036173017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p153844368307">Specifies the version ID, for example, v1.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313257__row143841136183018"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p2038423643018">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p2384736163019">List<Link></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p8384123653010">Specifies the API URL.</p>
|
|
<p id="en-us_topic_0133313257__p149851402025">For details, see <a href="#en-us_topic_0133313257__table86914347304">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313257__row14384173643012"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p8384153619301">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p8384133683015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p113841236183014">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_0133313257__row1138415367307"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p20385143614301">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p123851236133011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p41220831142214">Specifies the version status.</p>
|
|
<p id="en-us_topic_0133313257__p43374538142233">Possible values are as follows:</p>
|
|
<ul id="en-us_topic_0133313257__ul012713412324"><li id="en-us_topic_0133313257__li512714117322"><strong id="en-us_topic_0133313257__b842352706192132">CURRENT</strong>: indicates that the version is the primary version.</li><li id="en-us_topic_0133313257__li4162174311323"><strong id="en-us_topic_0133313257__b842352706192150">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="en-us_topic_0133313257__li1744304515328"><strong id="en-us_topic_0133313257__b1770020491281">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313257__row038814361309"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p8388133673018">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p123891236183012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p1938918364303">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_0133313257__row1638943618309"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p63894367302">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.077792220777923%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313257__p1738912361308">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p638963653019">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_0133313257__li838983616307"><strong id="en-us_topic_0133313257__b7125232913">Links</strong> field description
|
|
<div class="tablenoborder"><a name="en-us_topic_0133313257__table86914347304"></a><a name="table86914347304"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313257__table86914347304" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0133313257__row53898368307"><th align="left" class="cellrowborder" valign="top" width="20.79%" id="mcps1.3.4.2.3.2.2.4.1.1"><p id="en-us_topic_0133313257__p13895362301">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.4.2.3.2.2.4.1.2"><p id="en-us_topic_0133313257__p438913365302">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.21%" id="mcps1.3.4.2.3.2.2.4.1.3"><p id="en-us_topic_0133313257__p6389143683018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0133313257__row8389103623010"><td class="cellrowborder" valign="top" width="20.79%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="en-us_topic_0133313257__p7389436193014">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="en-us_topic_0133313257__p73891236123010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.21%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="en-us_topic_0133313257__p5389536123014">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0133313257__row6389163653017"><td class="cellrowborder" valign="top" width="20.79%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="en-us_topic_0133313257__p63891036163012">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="en-us_topic_0133313257__p13389133693017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.21%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="en-us_topic_0133313257__p03899362303">self</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0133313257__li1838923611303">Example response<p id="en-us_topic_0133313257__p148073472218"><a name="en-us_topic_0133313257__li1838923611303"></a><a name="li1838923611303"></a><strong id="en-us_topic_0133313257__b196586575284510">Status code: 200</strong></p>
|
|
<div class="p" id="en-us_topic_0133313257__p1748093410226">Successful operation<pre class="screen" id="en-us_topic_0133313257__screen54016179336">{
|
|
"version": {
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"rel": "self",
|
|
"href": "https://<em id="en-us_topic_0133313257__i1414163612334">API URL</em>/v1.0"
|
|
}
|
|
],
|
|
"version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2016-12-09T00:00:00Z",
|
|
"min_version": ""
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313257__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313257__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0133313257__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313257__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</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>
|
|
|