vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0065792793.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

159 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065792793"></a><a name="EN-US_TOPIC_0065792793"></a>
<h1 class="topictitle1">Querying All API Versions</h1>
<div id="body1499509081353"><div class="section" id="EN-US_TOPIC_0065792793__section54478915181842"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065792793__p40170843">This API is used to query all available Nova versions.</p>
<p id="EN-US_TOPIC_0065792793__p19479413244">To support function extension, Nova APIs can be distinguished by version. There are two types of versions:</p>
<ul id="EN-US_TOPIC_0065792793__ul132184206154"><li id="EN-US_TOPIC_0065792793__li132186202158">Major version: Independent URL</li><li id="EN-US_TOPIC_0065792793__li17218122051518">Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since microversion 2.27, the new microversion header OpenStack-API-Version has been supported.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section53791107181842"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065792793__p53736847103512">GET /</p>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section108201017144216"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065792793__p1429714229422">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section89511024194216"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065792793__p3661151916020">The following table describes the response parameters.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065792793__table1456520231001" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065792793__row25656239015"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0065792793__p45658231201">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0065792793__p125655231308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0065792793__p056515231709">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065792793__row456582314010"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p115651723008">versions</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p8565122310019">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p125121301517">Specifies the API versions. For details, see <a href="#EN-US_TOPIC_0065792793__table16114143917">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065792793__table16114143917"></a><a name="table16114143917"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065792793__table16114143917" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0065792793__b1872514012215">versions</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0065792793__row511412437116"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0065792793__p311454313119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0065792793__p91141643018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0065792793__p181143437120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065792793__row411414312112"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p8114943715">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p21141343213">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p1260613411515">Specifies the version ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row477413141835"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p167749141234">links</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p117741414039">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p65342421414">Specifies shortcut links for versions. For details, see <a href="#EN-US_TOPIC_0065792793__table1586318199718">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row4774151417318"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p077414142318">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p137741814033">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="EN-US_TOPIC_0065792793__ul46761225713"><li id="EN-US_TOPIC_0065792793__li26761922976">Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported minimum microversion. </li><li id="EN-US_TOPIC_0065792793__li186761228719">If the microversion is not supported, leave this parameter blank.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row107969153318"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p17961015939">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p1579713151538">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p8717131862">Specifies the API version status. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0065792793__ul6651646766"><li id="EN-US_TOPIC_0065792793__li19651124613619"><strong id="EN-US_TOPIC_0065792793__b345551023316">CURRENT</strong>: This is the preferred API version.</li><li id="EN-US_TOPIC_0065792793__li9651154615616"><strong id="EN-US_TOPIC_0065792793__b266615281339">SUPPORTED</strong>: This is the old API version that is still supported.</li><li id="EN-US_TOPIC_0065792793__li0651346768"><strong id="EN-US_TOPIC_0065792793__b1146319713714">DEPRECATED</strong>: This is the deprecated API version that will be removed.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row1449716334"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p144918166312">version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p17449716136">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="EN-US_TOPIC_0065792793__ul10933101420711"><li id="EN-US_TOPIC_0065792793__li1593310144714">Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported maximum microversion. </li><li id="EN-US_TOPIC_0065792793__li7933014877">If the microversion is not supported, leave this parameter blank.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row1488912161131"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p9889151613314">updated</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p88897161032">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p82093545426">The value of this parameter varies by API version.</p>
<p id="EN-US_TOPIC_0065792793__p088916161838">If the API version is 2.0, the value is <strong id="EN-US_TOPIC_0065792793__b1640403984718">2011-01-21T11:33:21Z</strong>. If the API version is 2.1, the value is <strong id="EN-US_TOPIC_0065792793__b319085174816">2013-07-23T11:33:21Z</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065792793__table1586318199718"></a><a name="table1586318199718"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065792793__table1586318199718" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065792793__b757151412396">links</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0065792793__row19863719071"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0065792793__p38643193712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0065792793__p1186420191678">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0065792793__p118647191972">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065792793__row1886419192713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p48646193713">href</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p786471915713">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0065792793__p55689555719">Specifies the links of the corresponding resources.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065792793__row178649191472"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0065792793__p386411192074">rel</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0065792793__p68646190716">string</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><ul id="EN-US_TOPIC_0065792793__ul83106471713"><li id="EN-US_TOPIC_0065792793__li1831064719718"><strong id="EN-US_TOPIC_0065792793__b8384122035215">self</strong>: A self link contains a versioned link to the resource. Use these links when the link is followed immediately.</li><li id="EN-US_TOPIC_0065792793__li53105473719"><strong id="EN-US_TOPIC_0065792793__b4501141611518">bookmark</strong>: A bookmark link provides a permanent link to a resource that is appropriate for long term storage.</li><li id="EN-US_TOPIC_0065792793__li831017474718"><strong id="EN-US_TOPIC_0065792793__b18458183631711">alternate</strong>: An alternate link can contain an alternate representation of the resource. <p id="EN-US_TOPIC_0065792793__p103164310816">For example, an OpenStack Compute image might have an alternate representation in the OpenStack Image service.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section39878380181842"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0065792793__p136841422162215">Query all API versions.</p>
<pre class="screen" id="EN-US_TOPIC_0065792793__screen1823314112119">GET https://{endpoint}/</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section569124244211"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065792793__screen187616428421">{
"versions":[
{
"min_version":"",
"links":[
{
"rel":"self",
"href":"https://{endpoint}/v2/"
}
],
"id":"v2.0",
"updated":"2011-01-21T11:33:21Z",
"version":"",
"status":"SUPPORTED"
},
{
"min_version":"2.1",
"links":[
{
"rel":"self",
"href":"https://{endpoint}/v2.1/"
}
],
"id":"v2.1",
"updated":"2013-07-23T11:33:21Z",
"version":"2.60",
"status":"CURRENT"
}
]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065792793__section12571834"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065792793__p21915813">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0065792792.html">API Version Query</a></div>
</div>
</div>
View Git Blame Copy Permalink