doc-exports/docs/cts/api-ref/en-us_topic_0168602243.html
Ying, Jiayu 14be087a3b CTS API 1122 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Ying, Jiayu <jiayuying1@huawei.com>
Co-committed-by: Ying, Jiayu <jiayuying1@huawei.com>
2022-12-09 10:04:38 +00:00

207 lines
18 KiB
HTML

<a name="en-us_topic_0168602243"></a><a name="en-us_topic_0168602243"></a>
<h1 class="topictitle1">Querying a Specified API Version</h1>
<div id="body8662426"><div class="section" id="en-us_topic_0168602243__s14614fd2e90249f2a00ff431b58d556b"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0168602243__en-us_topic_0133184491_p65561530">This API is used to query a specified API version of CTS.</p>
</div>
<div class="section" id="en-us_topic_0168602243__s66c905ae94ad4a81896c5e6f0de880ee"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0168602243__en-us_topic_0133184491_p11679114811">GET/{api_version}</p>
<div class="p" id="en-us_topic_0168602243__p185615411206">The URI parameters are described in <a href="#en-us_topic_0168602243__t2f4b2999b4784e78845eefcc5eefac90">Table 1</a>.
<div class="tablenoborder"><a name="en-us_topic_0168602243__t2f4b2999b4784e78845eefcc5eefac90"></a><a name="t2f4b2999b4784e78845eefcc5eefac90"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0168602243__t2f4b2999b4784e78845eefcc5eefac90" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="en-us_topic_0168602243__rdc2ba009c5a44fda8c8932cd467426f7"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.3.2.2.4.1.1"><p id="en-us_topic_0168602243__aa0f370895eb54cec85ccb5085c6c6086"><strong id="en-us_topic_0168602243__b842352706115119">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.2.2.4.1.2"><p id="en-us_topic_0168602243__a17bc27d00f7e4f8c8972352347ecde1b"><strong id="en-us_topic_0168602243__b842352706115121">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.2.3.2.2.4.1.3"><p id="en-us_topic_0168602243__a438c4c360956438491022a235aa79ade"><strong id="en-us_topic_0168602243__b842352706115259">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0168602243__r2a3d66ff4fab47d8a77ab46284cc7f1a"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="en-us_topic_0168602243__ad1fb114c63814589bbb9bb78381a2266">api_version</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="en-us_topic_0168602243__a3c677c4ed84b4c71b79e725c41d3d554">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="en-us_topic_0168602243__af4bea01a46bd4d22be26f3e25c347a20">API version</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="en-us_topic_0168602243__s43e8ae7913c64b42b4089af6a4bb7c0e"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0168602243__a6a11f3ebf7d04588b5d22cccd2ca0cab">None</p>
</div>
<div class="section" id="en-us_topic_0168602243__se4d7fb16a4304abba52627518b31ac64"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0168602243__en-us_topic_0133184491_ul5769005"><li id="en-us_topic_0168602243__ldbdb7965e1044eb0a14a50a4a0f59de8">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0168602243__t263122336250459e9ec01ffec56ae110" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="en-us_topic_0168602243__rb18c3fefdebb44d4ba0cbad406309d03"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="en-us_topic_0168602243__ac99751e3b99743be9b705df8725016d5"><strong id="en-us_topic_0168602243__b2107947345">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="en-us_topic_0168602243__en-us_topic_0133184491_p543845610355"><strong id="en-us_topic_0168602243__b1463720218">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="en-us_topic_0168602243__a5c880227147543d98f2434c60f7732c2"><strong id="en-us_topic_0168602243__b842352706115123">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="en-us_topic_0168602243__en-us_topic_0133184491_p244212561357"><strong id="en-us_topic_0168602243__b1588732078">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0168602243__r142682925e0b4a48acccff5421424035"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__abac252cf9780497eb83917cc6b446fda">version</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__ac05f072f2220464c824423f42e236e8f">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p444855610353">Array</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p344911569354">Information of the API version.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__r87b91e0d72cf434f898712c3c88b7f8b"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__aadd66af882714d0dba06a22bef915b13">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__a98b7dbe2700f4935ac19ec62f5305df9">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__a94f103f4c79f4bf78e57c7a5c2b53775">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p045585620357">Version ID (version number), for example, v1.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__r276c1d13c0bb4876aa41721ff95c41f6"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__a3aabde5277a54ddb98233f76d86d7171">links</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__add8b9996eee3446f87d74dbd29946b1b">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p346325618353">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p746525619351">API URL</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__row131913551711"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__p16283354130">href</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__p139117297139">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__p13242332181317">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__p2269104581219">Reference address of the current API version</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__row5612123213170"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__p2139956101218">rel</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__p1994102917139">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__p824653211138">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__p513917563125">Relationship between the current API version and the referenced address</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__r9ce51fe931a144c3869af318434886cb"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__ae33082d4b436400e9879d0c779929a41">version</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p164706561359">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__ace33aa601e144b0c9fea118df489ca46">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__acbefcc854668470fad0139c50833333c">If microversions are supported by the APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__r47aefcb639c34c5b9424cbc20e3636bb"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p647516561358">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p447812565352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__a85867596c81c4645aaabd08e5b81165b">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__ac8a6589500da484fbcc14e244f496afe">Version status. The value will be one of the following:</p>
<p id="en-us_topic_0168602243__a6889c7d117df43bda353644adfe505ea"><strong id="en-us_topic_0168602243__b131210509127">CURRENT</strong>: The version is the primary version.</p>
<p id="en-us_topic_0168602243__ab3a64fa2cb3b41b797e6122d0700d75d"><strong id="en-us_topic_0168602243__b17227195471210">SUPPORTED</strong>: The version is an old version, but it is still supported.</p>
<p id="en-us_topic_0168602243__af29a315255534a48aaf87dcd0118c9d8"><strong id="en-us_topic_0168602243__b11730155819127">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__ra0ae61f2decc4559aec48172eb70b51d"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__ae2d4298c05de4adfa2a5b41005171a5d">updated</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__a9dd320bf902847be9254421018a06a42">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__a985e8249324e4106be76df87f1e2e820">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__ab4745035d4014c3884e734939219603f">Version release time, which is the Coordinated Universal time (UTC). For example, the release time of v1 is <strong id="en-us_topic_0168602243__b13575456201215">2014-06-28T12:20:21Z</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__r7e2fbeb893894eca92c1a1a920c9ad22"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602243__ab5633a85365847acb6bdaabed082c8c8">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p14966566355">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602243__a7b50d389e8e2421fbcf50cded08baf59">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p205014565351">If microversions are supported by the APIs of the given version, the minimum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0168602243__en-us_topic_0133184491_li51921052">Example response<pre class="screen" id="en-us_topic_0168602243__sb714605a587d49178e67b597a401d144">{
"version":
{
"id": "v1.0",
"links": [
{
"href": "https://<em id="en-us_topic_0168602243__a83e73d53b5254169bc55c921bf5ca827">x.x.x.x</em>/v1.0/",
"rel": "self"
}
],
"min_version": "",
"status": "CURRENT",
"updated": "2018-09-30T00:00:00Z",
"version": ""
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0168602243__s4d3f9f864ef240d5aede6b6c784671b8"><h4 class="sectiontitle">Returned Value</h4><ul id="en-us_topic_0168602243__en-us_topic_0133184491_ul20226985"><li id="en-us_topic_0168602243__en-us_topic_0133184491_li47825138">Normal<p id="en-us_topic_0168602243__en-us_topic_0133184491_p27773061"><a name="en-us_topic_0168602243__en-us_topic_0133184491_li47825138"></a><a name="en-us_topic_0133184491_li47825138"></a>200</p>
</li><li id="en-us_topic_0168602243__en-us_topic_0133184491_li48630964">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0168602243__en-us_topic_0133184491_table46793998" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Return code for failed requests</caption><thead align="left"><tr id="en-us_topic_0168602243__en-us_topic_0133184491_row65573909"><th align="left" class="cellrowborder" valign="top" width="61.839999999999996%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="en-us_topic_0168602243__en-us_topic_0133184491_p9886408"><strong id="en-us_topic_0168602243__b842352706112115">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.16%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="en-us_topic_0168602243__en-us_topic_0133184491_p62601592"><strong id="en-us_topic_0168602243__b122115083">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0168602243__en-us_topic_0133184491_row37564172"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p22799085">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p44643603">Request error.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row66248115"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p64497130">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p42202994">The authentication information is not provided or is incorrect.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row44282627"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p30123063">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p15114764">The request was forbidden.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__row1385894717145"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__p6738773164846">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__p8969753164846">The server failed to find the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row1815156"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p12809933">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p10309404">The request timed out.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row25675773"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p66471715">429 Too Many Requests</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p5281111">The number of requests exceeded the upper limit.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row47530006"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p24725298">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p39567352">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="en-us_topic_0168602243__en-us_topic_0133184491_row20561848"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602243__en-us_topic_0133184491_p54897010">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602243__a30ba56fc3d6d4269ab9eed7e32e91d0e">The service is currently unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0168602231.html">API Version Management</a></div>
</div>
</div>