forked from docs/doc-exports
Liu, Siying
61db61b4e5
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
176 lines
14 KiB
HTML
176 lines
14 KiB
HTML
<a name="cts_api_00325"></a><a name="cts_api_00325"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_00325__en-us_topic_0257057098_section181514462414"><h4 class="sectiontitle">Function</h4><p id="cts_api_00325__en-us_topic_0257057098_p215115466415">This API is used to query all API versions supported by CTS.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section11511465415"><h4 class="sectiontitle">URI</h4><p id="cts_api_00325__en-us_topic_0257057098_p151528468416">GET /</p>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section1515254634113"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_00325__en-us_topic_0257057098_p11528464413">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section71526466411"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_00325__en-us_topic_0257057098_p1715274616411"><strong id="cts_api_00325__en-us_topic_0257057098_b16595152113491">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_00325__en-us_topic_0257057098_response_ListVersionsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_00325__en-us_topic_0257057098_row715354694119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_00325__en-us_topic_0257057098_p15153164613419"><strong id="cts_api_00325__en-us_topic_0257057098_b122143095019">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="cts_api_00325__en-us_topic_0257057098_p18154204684116">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="cts_api_00325__en-us_topic_0257057098_p01541046104113">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_00325__en-us_topic_0257057098_row201531946164113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p10154134684111">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p12154164664113">Array of <a href="#cts_api_00325__en-us_topic_0257057098_response_Version">Versions</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p131541046104116">List of all versions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_00325__en-us_topic_0257057098_response_Version"></a><a name="en-us_topic_0257057098_response_Version"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_00325__en-us_topic_0257057098_response_Version" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Versions</caption><thead align="left"><tr id="cts_api_00325__en-us_topic_0257057098_row315564684117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_00325__en-us_topic_0257057098_p14155154614412"><strong id="cts_api_00325__en-us_topic_0257057098_b1170726195114">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cts_api_00325__en-us_topic_0257057098_p14156246174111">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="cts_api_00325__en-us_topic_0257057098_p121561546184111">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_00325__en-us_topic_0257057098_row1915515464418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p215617466412">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p12156114611412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p161566461418">Specifies the version ID, for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row201551346104111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p715619465418">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p1915664694113">Array of <a href="#cts_api_00325__en-us_topic_0257057098_response_LinksBody">LinksBody</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p615612463416">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row91551146124118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p71571246184113">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p715724614410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p17157124604120">If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row1715544624113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p5157194613415">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p151570465415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p12157746194112">Specifies the version status. <strong id="cts_api_00325__en-us_topic_0257057098_b1093233414522">CURRENT</strong>: widely used version. <strong id="cts_api_00325__en-us_topic_0257057098_b18219645313">SUPPORTED</strong>: earlier version that is still supported. <strong id="cts_api_00325__en-us_topic_0257057098_b396610241531">DEPRECATED</strong>: deprecated version which may be deleted later.</p>
|
|
<p id="cts_api_00325__en-us_topic_0257057098_p111575460411">Value:</p>
|
|
<ul id="cts_api_00325__en-us_topic_0257057098_ul1115734624111"><li id="cts_api_00325__en-us_topic_0257057098_li4157164674114"><strong id="cts_api_00325__en-us_topic_0257057098_b14157154617412">CURRENT</strong></li><li id="cts_api_00325__en-us_topic_0257057098_li18157184612415"><strong id="cts_api_00325__en-us_topic_0257057098_b111585465413">SUPPORTED</strong></li><li id="cts_api_00325__en-us_topic_0257057098_li4158846114114"><strong id="cts_api_00325__en-us_topic_0257057098_b81586463414">DEPRECATED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row41553463415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p1415874614113">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p715804644110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p1115844674115">The version release time in UTC. For example, the release time of v1 is <strong id="cts_api_00325__en-us_topic_0257057098_b4570113765612">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row8155134674119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p5158124624120">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p115894604112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p10158154604115">If microversions are supported, set this parameter to the minimum microversion supported. Otherwise, leave this parameter empty.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cts_api_00325__en-us_topic_0257057098_response_LinksBody"></a><a name="en-us_topic_0257057098_response_LinksBody"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_00325__en-us_topic_0257057098_response_LinksBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>LinksBody</caption><thead align="left"><tr id="cts_api_00325__en-us_topic_0257057098_row111591246154110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_00325__en-us_topic_0257057098_p1115934684115">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="cts_api_00325__en-us_topic_0257057098_p7159446184115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="cts_api_00325__en-us_topic_0257057098_p5159946134115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_00325__en-us_topic_0257057098_row615920466417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p515934644112">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p4160146164112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p1016010460413">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row16159194644112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p121609467415">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p0160134611412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_00325__en-us_topic_0257057098_p7160124694111">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section1016004613417"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_00325__en-us_topic_0257057098_p816014613411">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section121603463411"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_00325__en-us_topic_0257057098_p71617464411"><strong id="cts_api_00325__en-us_topic_0257057098_b1443954024919">Status code: 200</strong></p>
|
|
<p id="cts_api_00325__en-us_topic_0257057098_p121619465416">The request is successful.</p>
|
|
<pre class="screen" id="cts_api_00325__en-us_topic_0257057098_screen191611346144116">{
|
|
"versions" : [ {
|
|
"id" : "v1.0",
|
|
"links" : {
|
|
"href" : "https://x.x.x.x/v1.0/",
|
|
"rel" : "self"
|
|
},
|
|
"min_version" : "",
|
|
"status" : "CURRENT",
|
|
"updated" : "2018-09-30T00:00:00Z",
|
|
"version" : ""
|
|
}, {
|
|
"id" : "v2.0",
|
|
"links" : {
|
|
"href" : "https://x.x.x.x/v2.0/",
|
|
"rel" : "self"
|
|
},
|
|
"min_version" : "",
|
|
"status" : "SUPPORTED",
|
|
"updated" : "2018-09-30T00:00:00Z",
|
|
"version" : ""
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section71631746114111"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_00325__en-us_topic_0257057098_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_00325__en-us_topic_0257057098_row81631146174115"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_00325__en-us_topic_0257057098_p191631046124112">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="cts_api_00325__en-us_topic_0257057098_p111631646184119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_00325__en-us_topic_0257057098_row31631446184112"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p1216484624116">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p31641746124115">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row141635464412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p61641546114119">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p1116464613416">The server failed to find the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_00325__en-us_topic_0257057098_row151631746134118"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_00325__en-us_topic_0257057098_p11165174610416">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_00325__en-us_topic_0257057098_p13165114611418">The server encountered an unexpected condition which prevented it from fulfilling the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_00325__en-us_topic_0257057098_section131656464416"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_00325__en-us_topic_0257057098_p1816511468416">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cts_api_0010.html">API Version Management</a></div>
|
|
</div>
|
|
</div>
|
|
|