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>
189 lines
15 KiB
HTML
189 lines
15 KiB
HTML
<a name="cts_api_0012"></a><a name="cts_api_0012"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Specific API Version</h1>
|
|
<div id="body8662426"><div class="section" id="cts_api_0012__en-us_topic_0257057099_section0212104684115"><h4 class="sectiontitle">Function</h4><p id="cts_api_0012__en-us_topic_0257057099_p721294634111">This API is used to query a specified API version of CTS.</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0012__en-us_topic_0257057099_section10213646154117"><h4 class="sectiontitle">URI</h4><p id="cts_api_0012__en-us_topic_0257057099_p121304674114">GET /{version}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0012__en-us_topic_0257057099_table20213146164118" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="cts_api_0012__en-us_topic_0257057099_row42139466412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cts_api_0012__en-us_topic_0257057099_p172131046174113">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="cts_api_0012__en-us_topic_0257057099_p52143463419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="cts_api_0012__en-us_topic_0257057099_p152148466418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="cts_api_0012__en-us_topic_0257057099_p1521420464414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0012__en-us_topic_0257057099_row221354674117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p102141246104117">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p02146465410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p122145467413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cts_api_0012__en-us_topic_0257057099_p32154469416">Version number.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cts_api_0012__en-us_topic_0257057099_section12215194618412"><h4 class="sectiontitle">Request Parameters</h4><p id="cts_api_0012__en-us_topic_0257057099_p1721534624112">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0012__en-us_topic_0257057099_section6215646124114"><h4 class="sectiontitle">Response Parameters</h4><p id="cts_api_0012__en-us_topic_0257057099_p122151846204119"><strong id="cts_api_0012__en-us_topic_0257057099_b125077112144941">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0012__en-us_topic_0257057099_response_ListSpecificVersionResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="cts_api_0012__en-us_topic_0257057099_row921519462411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="cts_api_0012__en-us_topic_0257057099_p72161946124113">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="cts_api_0012__en-us_topic_0257057099_p021619469417">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_0012__en-us_topic_0257057099_p192162464418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0012__en-us_topic_0257057099_row62161446184113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p1216946134115">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p621664615419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p8217124664116">Information of the version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0012__en-us_topic_0257057099_response_Version" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Version</caption><thead align="left"><tr id="cts_api_0012__en-us_topic_0257057099_row18217946124115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="cts_api_0012__en-us_topic_0257057099_p1321844694115">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="cts_api_0012__en-us_topic_0257057099_p72181946124113">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_0012__en-us_topic_0257057099_p121834664117">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0012__en-us_topic_0257057099_row132175469412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p15218154610414">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p22181846194116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p721884613418">Specifies the version ID, for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row2021716467412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p1221894674119">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p122191246174116">Array of <a href="#cts_api_0012__en-us_topic_0257057099_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_0012__en-us_topic_0257057099_p4219134674116">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row221784644110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p1219246174110">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p17219146194113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p92199463418">If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row22171746194119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p42209468417">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p92209466411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p9220184615414">Specifies the version status. <strong id="cts_api_0012__en-us_topic_0257057099_b414714819536">CURRENT</strong>: widely used version. <strong id="cts_api_0012__en-us_topic_0257057099_b5643105465318">SUPPORTED</strong>: earlier version that is still supported. <strong id="cts_api_0012__en-us_topic_0257057099_b131160694945347">DEPRECATED</strong>: deprecated version which may be deleted later.</p>
|
|
<p id="cts_api_0012__en-us_topic_0257057099_p522024617413">Value:</p>
|
|
<ul id="cts_api_0012__en-us_topic_0257057099_ul6220184614113"><li id="cts_api_0012__en-us_topic_0257057099_li5220946194113"><strong id="cts_api_0012__en-us_topic_0257057099_b16220846194118">CURRENT</strong></li><li id="cts_api_0012__en-us_topic_0257057099_li42202046124111"><strong id="cts_api_0012__en-us_topic_0257057099_b222164604111">SUPPORTED</strong></li><li id="cts_api_0012__en-us_topic_0257057099_li1422111461418"><strong id="cts_api_0012__en-us_topic_0257057099_b4221164615415">DEPRECATED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row102179465419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p62211246154116">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p1622118466414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p10221846124115">The version release time in UTC. For example, the release time of v1 is <strong id="cts_api_0012__en-us_topic_0257057099_b2299629622211">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row112171246184113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p922114644110">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p2022134654113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p1922115466414">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_0012__en-us_topic_0257057099_response_LinksBody"></a><a name="en-us_topic_0257057099_response_LinksBody"></a><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0012__en-us_topic_0257057099_response_LinksBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>LinksBody</caption><thead align="left"><tr id="cts_api_0012__en-us_topic_0257057099_row1222224694116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="cts_api_0012__en-us_topic_0257057099_p132221146194114">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_0012__en-us_topic_0257057099_p112221446174116">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_0012__en-us_topic_0257057099_p4222546114114">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0012__en-us_topic_0257057099_row222264612413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p132231646164119">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p52231946184113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p2022324610419">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row622284613419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p1322344664113">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p14223746194118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cts_api_0012__en-us_topic_0257057099_p1722384654116">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_0012__en-us_topic_0257057099_section1722412465417"><h4 class="sectiontitle">Example Request</h4><p id="cts_api_0012__en-us_topic_0257057099_p1224446114113">None</p>
|
|
</div>
|
|
<div class="section" id="cts_api_0012__en-us_topic_0257057099_section14224174634112"><h4 class="sectiontitle">Example Response</h4><p id="cts_api_0012__en-us_topic_0257057099_p17224146154115"><strong id="cts_api_0012__en-us_topic_0257057099_b85176510044941">Status code: 200</strong></p>
|
|
<p id="cts_api_0012__en-us_topic_0257057099_p20224144610417">The request is successful.</p>
|
|
<pre class="screen" id="cts_api_0012__en-us_topic_0257057099_screen14224104617412">{
|
|
"version" : {
|
|
"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" : ""
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cts_api_0012__en-us_topic_0257057099_section132253467410"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cts_api_0012__en-us_topic_0257057099_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cts_api_0012__en-us_topic_0257057099_row122644611413"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cts_api_0012__en-us_topic_0257057099_p62261462413">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_0012__en-us_topic_0257057099_p1522624618411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cts_api_0012__en-us_topic_0257057099_row15226164612416"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p16226104615411">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p622716467418">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row11226046114110"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p8227154619418">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p9227114604114">The server failed to find the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cts_api_0012__en-us_topic_0257057099_row122644614117"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cts_api_0012__en-us_topic_0257057099_p142271446114111">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cts_api_0012__en-us_topic_0257057099_p822744612415">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_0012__en-us_topic_0257057099_section202271846164119"><h4 class="sectiontitle">Error Codes</h4><p id="cts_api_0012__en-us_topic_0257057099_p1322719466415">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>
|
|
|