forked from docs/doc-exports
Dong, Qiu Jian
3336ba8df7
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
146 lines
11 KiB
HTML
146 lines
11 KiB
HTML
<a name="cce_02_0349"></a><a name="cce_02_0349"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body1569402041071"><div class="section" id="cce_02_0349__se2e066518e534a58a022d07edfbd4a3f"><h4 class="sectiontitle">Function</h4><p id="cce_02_0349__aee12d23cb2f94183a47c5f47bedcfa52">This API is used to query all available API versions.</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0349__s9ba079db556c4be7998a917fb1004946"><h4 class="sectiontitle">URI</h4><p id="cce_02_0349__en-us_topic_0102499074_p23575517439">GET /</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0349__sfa7f4cd949044a198e9f9a0518344e7f"><h4 class="sectiontitle">Request</h4><p id="cce_02_0349__p1375494816514">N/A</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0349__s2eb2c416e8d344619301671f0baffc10"><h4 class="sectiontitle">Response</h4><p id="cce_02_0349__a39163766c1764404a83f5a8ac99fcdaa"><strong id="cce_02_0349__en-us_topic_0102499074_b2611581026">Response parameters:</strong></p>
|
|
<p id="cce_02_0349__en-us_topic_0102499074_p46145810219"><a href="#cce_02_0349__table986610460219">Table 1</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0349__table986610460219"></a><a name="table986610460219"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0349__table986610460219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="cce_02_0349__row3867846192120"><th align="left" class="cellrowborder" valign="top" width="20.392039203920394%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0349__p1086764618217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.23212321232123%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0349__p10867184611219">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.37583758375837%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0349__p08676468210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0349__row20867124611213"><td class="cellrowborder" valign="top" width="20.392039203920394%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0349__p2086715463216">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.23212321232123%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0349__p178672046192113">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.37583758375837%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0349__p129231114292">API version list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0349__tcce801e285854dccb353b947a7438f7e" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure of the versions field</caption><thead align="left"><tr id="cce_02_0349__rcfece3d94f00439c886626d8c9fd8ead"><th align="left" class="cellrowborder" valign="top" width="17.77%" id="mcps1.3.4.5.2.5.1.1"><p id="cce_02_0349__ae4b83b624fe9400280500de14f852957">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.870000000000001%" id="mcps1.3.4.5.2.5.1.2"><p id="cce_02_0349__p187612148111">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.5%" id="mcps1.3.4.5.2.5.1.3"><p id="cce_02_0349__af9564978f187443a837b5dc2ba197568">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.86000000000001%" id="mcps1.3.4.5.2.5.1.4"><p id="cce_02_0349__aaed6ccd6f45949ab97d3cd07a9006af8">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0349__rf35ded239f3047f4af05feecded6115c"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p109666131210">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p796351019124">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p2816319131213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p19449832141215">API version ID, for example, v3.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0349__r3a6b7a4ae3424f3589f19eae5b6cf393"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p169676110128">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p14963410101214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p28173196126">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p18449163213123">API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0349__row12671143117576"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p16882636175719">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p1882153685714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p4882103615573">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p6166165673612">API microversion.</p>
|
|
<ul id="cce_02_0349__ul1058019424376"><li id="cce_02_0349__li1428419362242">If the API has microversions, the parameter value is the earliest version number supported.</li><li id="cce_02_0349__li73528122411">If the API does not have microversions, the parameter is left blank.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0349__rc87772ef04774dcb860fcae5b8403556"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p79671614122">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p64668816565">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p0817101941213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p184493325123">API version status.</p>
|
|
<ul id="cce_02_0349__ul1483715326178"><li id="cce_02_0349__li283723216172"><strong id="cce_02_0349__b58371432181719">CURRENT</strong>: The version is a mainstream version.</li><li id="cce_02_0349__li7831103618171"><strong id="cce_02_0349__b1283123612175">SUPPORTED</strong>: The version is not the latest one but it is still in use.</li><li id="cce_02_0349__li48378324178"><strong id="cce_02_0349__b18838163231715">DEPRECATED</strong>: The version is deprecated and will probably be deleted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0349__row06881052171110"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p1596751131216">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p296361014129">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p1381761913126">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p4449103219127">Version release time in UTC. For example, the parameter value for v1 is 2014-06-28T12:20:21Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0349__row268912525118"><td class="cellrowborder" valign="top" width="17.77%" headers="mcps1.3.4.5.2.5.1.1 "><p id="cce_02_0349__p13786204713575">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.870000000000001%" headers="mcps1.3.4.5.2.5.1.2 "><p id="cce_02_0349__p107861547115719">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.4.5.2.5.1.3 "><p id="cce_02_0349__p16786104712578">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.86000000000001%" headers="mcps1.3.4.5.2.5.1.4 "><p id="cce_02_0349__p1323821834016">API version number.</p>
|
|
<ul id="cce_02_0349__ul18313527114018"><li id="cce_02_0349__li7313122715401">If the API version has microversions, the parameter value is the highest version number supported.</li><li id="cce_02_0349__li231332711406">If the API version does not have API mini versions, the parameter is left blank.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0349__a5ed7aae83cbb4cc5b8df5ad768328381"><strong id="cce_02_0349__en-us_topic_0102499074_b476113439112">Example response:</strong></p>
|
|
<pre class="screen" id="cce_02_0349__screen14162457723">{
|
|
"versions": [
|
|
{
|
|
"id": "v3",
|
|
"links": [
|
|
{
|
|
"href": "https://container.eu-de.***.t-systems.com/v3",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2018-09-15T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cce_02_0349__sf5b489c1f62d4d909a30f683dc319340"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0349__a98afa956aea042c8843852e6d5c16e4e"><a href="#cce_02_0349__t8935d48c19714740abd2e888a39be462">Table 3</a> describes the status code of the API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0349__t8935d48c19714740abd2e888a39be462"></a><a name="t8935d48c19714740abd2e888a39be462"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0349__t8935d48c19714740abd2e888a39be462" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="cce_02_0349__re974d044247140b79c213fc577abe0ae"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0349__a9465a1e476c948e4b40095738594daf3">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0349__a88c1c2f27be844b7b79dad7e1a5b06f2">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0349__rb535f7f0f62341f7b636e54ce399b342"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0349__ad1d3b647d2f746cc88b562f3eb1ff493">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0349__a78dc15895d744bb9affa7db6de6e02e5">The query operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0349__en-us_topic_0102499074_p347213715512">For details about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0348.html">API Version Query</a></div>
|
|
</div>
|
|
</div>
|
|
|