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>
210 lines
15 KiB
HTML
210 lines
15 KiB
HTML
<a name="ces_03_0021"></a><a name="ces_03_0021"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Specified API Version</h1>
|
|
<div id="body1537959787782"><div class="section" id="ces_03_0021__section66578044"><h4 class="sectiontitle">Function</h4><p id="ces_03_0021__p65561530">This API is used to query a specified API version of Cloud Eye.</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0021__section62331491"><h4 class="sectiontitle">URI</h4><p id="ces_03_0021__p11679114811">GET /{api_version}</p>
|
|
<ul id="ces_03_0021__ul13304185019615"><li id="ces_03_0021__li133042050464">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0021__table23820074175412" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0021__row17704405175412"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="ces_03_0021__p24770673175412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="ces_03_0021__p60267522175412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.08%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="ces_03_0021__p49831152175412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0021__row9791522175412"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="ces_03_0021__p54915841175412">api_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="ces_03_0021__p18998132175412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.08%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="ces_03_0021__p62453732175412">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="ces_03_0021__ul8883693"><li id="ces_03_0021__li5680114416102">Example<pre class="screen" id="ces_03_0021__screen14211813194545">GET https://{Cloud Eye endpoint}/V1.0\</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0021__section24112512"><h4 class="sectiontitle">Request</h4><p id="ces_03_0021__p14422152216915">None</p>
|
|
</div>
|
|
<div class="section" id="ces_03_0021__section15686020"><h4 class="sectiontitle">Response</h4><ul id="ces_03_0021__ul5769005"><li id="ces_03_0021__li62568603152631">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0021__table26246518152631" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="ces_03_0021__row29602547152631"><th align="left" class="cellrowborder" valign="top" width="18.72%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="ces_03_0021__p1143665616354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.73%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="ces_03_0021__p11440156143517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.55%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="ces_03_0021__p244212561357">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0021__row56174697152631"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="ces_03_0021__p4445556153516">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="ces_03_0021__p444855610353">Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="ces_03_0021__p344911569354">Specifies the list of all versions.</p>
|
|
<p id="ces_03_0021__p76411522123610">For details, see <a href="#ces_03_0021__table697164712507">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ces_03_0021__table697164712507"></a><a name="table697164712507"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0021__table697164712507" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="ces_03_0021__b220894318477">versions</strong> data structure description</caption><thead align="left"><tr id="ces_03_0021__row1898124785019"><th align="left" class="cellrowborder" valign="top" width="18.72%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="ces_03_0021__p4981247195018">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.73%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="ces_03_0021__p79844713504">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.55%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="ces_03_0021__p698194713501">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0021__row89854714509"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p139834735010">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p298114755020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p179964715014">Specifies the version ID, for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row299164795019"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p199919474509">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p8991047175014">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p59964795019">Specifies the API URL.</p>
|
|
<p id="ces_03_0021__p181431404541">For details, see <a href="#ces_03_0021__table826514508503">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row79914725015"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p199974711501">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p12992477506">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p1613574610538">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_0021__row1910011478501"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p4100134718509">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p110019470505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p1210024725017">Specifies the version status.</p>
|
|
<p id="ces_03_0021__p1010024712509"><strong id="ces_03_0021__b842352706192132">CURRENT</strong>: indicates a primary version.</p>
|
|
<p id="ces_03_0021__p210054735017"><strong id="ces_03_0021__b842352706192150">SUPPORTED</strong>: indicates an old version but is still supported.</p>
|
|
<p id="ces_03_0021__p1100047125014"><strong id="ces_03_0021__b84235270619220">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row1310017478505"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p3100154715016">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p141001847135012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p9100164765020">Specifies the version release time, which must be the UTC time. For example, the release time of v1 is <strong id="ces_03_0021__b199874410294">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row5100144717502"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="ces_03_0021__p1310010474502">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="ces_03_0021__p7100134735019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="ces_03_0021__p7556103913538">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_0021__table826514508503"></a><a name="table826514508503"></a><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0021__table826514508503" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="ces_03_0021__b5964344104820">links</strong> data structure description</caption><thead align="left"><tr id="ces_03_0021__row15266125018507"><th align="left" class="cellrowborder" valign="top" width="18.72%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="ces_03_0021__p726618502508">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.73%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="ces_03_0021__p11266135011504">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.55%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="ces_03_0021__p726625019507">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0021__row16267105014508"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0021__p726735018501">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0021__p1526745015503">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0021__p1726735085010">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row1326725018501"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="ces_03_0021__p72674509503">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="ces_03_0021__p132670509503">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.55%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="ces_03_0021__p15267750125020">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="ces_03_0021__li51921052">Example response<pre class="screen" id="ces_03_0021__screen19808142315710">{
|
|
"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>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0021__section6956456"><h4 class="sectiontitle">Returned Values</h4><ul id="ces_03_0021__ul20226985"><li id="ces_03_0021__li47825138">Normal<p id="ces_03_0021__p27773061"><a name="ces_03_0021__li47825138"></a><a name="li47825138"></a>200</p>
|
|
</li><li id="ces_03_0021__li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ces_03_0021__table164131229143215" frame="border" border="1" rules="all"><thead align="left"><tr id="ces_03_0021__row1641352953214"><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_0021__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_0021__p15553712182924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ces_03_0021__row141362973213"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p164784039168">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row54131629163220"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p218024949168">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row8413192914328"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p661449719168">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row134131129113213"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p585420329168">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row124139297327"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p37560249168">Concurrent requests are excessive.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row441352911324"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p618106189168">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ces_03_0021__row94139296322"><td class="cellrowborder" valign="top" width="32.1%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="ces_03_0021__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_0021__p54144829168">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ces_03_0021__section137621219143417"><h4 class="sectiontitle">Error Codes</h4><p id="ces_03_0021__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>
|
|
|