forked from docs/doc-exports
Youyuan, Pan
5bdbeeee8c
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Youyuan, Pan <panyouyuan@huawei.com> Co-committed-by: Youyuan, Pan <panyouyuan@huawei.com>
191 lines
13 KiB
HTML
191 lines
13 KiB
HTML
<a name="ces_03_0020"></a><a name="ces_03_0020"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body1537943421235"><div class="section" id="ces_03_0020__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0020__p65561530">This API is used to query all API versions supported by Cloud Eye.</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0020__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0020__p48490504">GET /</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0020__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0020__p45638969">Example request</p>
|
|
<pre class="screen" id="ces_03_0020__screen177771956131416">GET https://{Cloud Eye endpoint}/</pre>
|
|
</div>
|
|
<div class="section" id="ces_03_0020__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0020__ul5769005"><li id="ces_03_0020__li62568603152631">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0020__table26246518152631" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0020__row29602547152631"><th align="left" class="cellrowborder" valign="top" width="17.61%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0020__p1143665616354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0020__p11440156143517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.16%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0020__p244212561357">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0020__row56174697152631"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0020__p4445556153516">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0020__p444855610353">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0020__p344911569354">Specifies the list of all versions.</p>
|
|
<p id="ces_03_0020__p76411522123610">For details, see <a href="#ces_03_0020__table11622191810339">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0020__table11622191810339"></a><a name="table11622191810339"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0020__table11622191810339" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="ces_03_0020__b1922145363015">versions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0020__row4619181833318"><th align="left" class="cellrowborder" valign="top" width="17.61%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0020__p8618218183315">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0020__p46182182336">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.16%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0020__p1361819181337">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0020__row1261921810335"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p1619718203313">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p186194185335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p8619418123311">Specifies the version ID, for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row106201018103311"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p12620181823313">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p12620171823314">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p46207186338">Specifies the API URL.</p>
|
|
<p id="ces_03_0020__p551085418378">For details, see <a href="#ces_03_0020__table7157926103418">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row186211518163313"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p1562111184330">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p762171863315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p196210182338">Specifies the API version. If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row862171813317"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p262191883312">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p20621118153312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p362121813335">Specifies the version status.</p>
|
|
<p id="ces_03_0020__p10621201813316"><strong id="ces_03_0020__b842352706192132">CURRENT</strong>: indicates a primary version.</p>
|
|
<p id="ces_03_0020__p662112186338"><strong id="ces_03_0020__b1164542231713">SUPPORTED</strong>: indicates an old version but is still supported.</p>
|
|
<p id="ces_03_0020__p18621141813331"><strong id="ces_03_0020__b164043941413">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row16223181336"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p1062261817332">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p16228184334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p56220183330">Specifies the version release time, which must be the UTC time. For example, the release time of v1 is <strong id="ces_03_0020__b13664103142818">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row206221018163316"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0020__p8622171816333">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0020__p4622121819338">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0020__p16221118103315">If the APIs of this version support microversions, set this parameter to the supported minimum microversion. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0020__table7157926103418"></a><a name="table7157926103418"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0020__table7157926103418" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0020__b114279459310">links</strong> data structure description</caption><thead align="left"><tr id="ces_03_0020__row6157112653419"><th align="left" class="cellrowborder" valign="top" width="17.61%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="ces_03_0020__p1515711268345">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="ces_03_0020__p4157192614343">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.16%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="ces_03_0020__p7157102613346">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0020__row1915852612341"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0020__p1515872614346">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0020__p2158162616349">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0020__p615813265341">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row1158182615345"><td class="cellrowborder" valign="top" width="17.61%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0020__p4158162633414">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0020__p191584262345">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0020__p4158182603413">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0020__li51921052">Example response<pre class="screen" id="ces_03_0020__screen19808142315710">{
|
|
"versions": [
|
|
{
|
|
"id": "V1.0",
|
|
"links": [
|
|
{
|
|
"href": "https://<em id="ces_03_0020__i0481110191610">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="ces_03_0020__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0020__ul20226985"><li id="ces_03_0020__li47825138">Normal<p id="ces_03_0020__p27773061"><a name="ces_03_0020__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0020__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0020__table6403161913220" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0020__row9403111913213"><th align="left" class="cellrowborder" valign="top" width="32.1%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="ces_03_0020__p1849030182924">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.9%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="ces_03_0020__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0020__row184034193325"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p581987519168">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row24031619173210"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p2691669168">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row1240310199325"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p563264059168">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row1040314198323"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p355199299168">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row11403111917326"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p630127129168">429 Too Many Requests</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row740341916324"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p537873819168">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0020__row12403161915329"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0020__p298930079168">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.9%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="ces_03_0020__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0020__section137621219143417"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0020__p91851023153416">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ces_03_0019.html">API Version Management</a></div>
|
|
</div>
|
|
</div>
|
|
|