forked from docs/doc-exports
Qin Ying, Fan
65b77b76d4
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
118 lines
11 KiB
HTML
118 lines
11 KiB
HTML
<a name="eip_openstackapi_0002"></a><a name="eip_openstackapi_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions</h1>
|
|
<div id="body8662426"><div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section47928120"><h4 class="sectiontitle">Function</h4><p id="eip_openstackapi_0002__en-us_topic_0201534229_p39860200">This API is used to query all available versions of a native OpenStack API.</p>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section28699899"><h4 class="sectiontitle">URI</h4><p id="eip_openstackapi_0002__en-us_topic_0201534229_p33081345111049">GET /</p>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section42990474"><h4 class="sectiontitle">Request Parameters</h4><p id="eip_openstackapi_0002__en-us_topic_0201534229_p4775574">None</p>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section167693416553"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="eip_openstackapi_0002__en-us_topic_0201534229_screen173165612148">GET https://{Endpoint}/</pre>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section51369953"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0002__en-us_topic_0201534229_table51277242" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row64740644"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.2.2.4.1.1"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p9500791"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b842352706193648">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.5.2.2.4.1.2"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p31366578"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b842352706193653">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.5.2.2.4.1.3"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p40344834"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row46706151"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.2.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p25101909">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.2.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p1668082023018">Array of <a href="#eip_openstackapi_0002__en-us_topic_0201534229_table7472653181512">version</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.2.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p15291872">Specifies the API version list. For details, see <a href="#eip_openstackapi_0002__en-us_topic_0201534229_table7472653181512">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="eip_openstackapi_0002__en-us_topic_0201534229_table7472653181512"></a><a name="en-us_topic_0201534229_table7472653181512"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0002__en-us_topic_0201534229_table7472653181512" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b20193639191119">version</strong> objects</caption><thead align="left"><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row24721153191511"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.3.2.4.1.1"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p7472853151518"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b04872545271">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.5.3.2.4.1.2"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p1647210534155"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b604290506">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.5.3.2.4.1.3"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p11472185317150"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b13097052814">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row18472155310158"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p147217533154">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p947255320159">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.3.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p47752014191">Specifies the API version status. Possible values are as follows:</p>
|
|
<ul id="eip_openstackapi_0002__en-us_topic_0201534229_ul1053872581218"><li id="eip_openstackapi_0002__en-us_topic_0201534229_li153882516123"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b84235270619587">CURRENT</strong></li><li id="eip_openstackapi_0002__en-us_topic_0201534229_li453842501212"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b1776824032913">STABLE</strong></li><li id="eip_openstackapi_0002__en-us_topic_0201534229_li18538152511213"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b1095445010297">DEPRECATED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_openstackapi_0002__en-us_topic_0201534229_row747215312152"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p10472115381512">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p9472115313158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.3.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p647375331518">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_openstackapi_0002__en-us_topic_0201534229_row174734534159"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p18473105321516">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p984011365304">Array of <a href="#eip_openstackapi_0002__en-us_topic_0201534229_table62331111162">link</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.3.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p164731253181513">Specifies the link list. For details, see <a href="#eip_openstackapi_0002__en-us_topic_0201534229_table62331111162">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="eip_openstackapi_0002__en-us_topic_0201534229_table62331111162"></a><a name="en-us_topic_0201534229_table62331111162"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_openstackapi_0002__en-us_topic_0201534229_table62331111162" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b330155711111">link</strong> objects</caption><thead align="left"><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row1823611191619"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.4.2.4.1.1"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p19231111161619"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b1991194683010">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.5.4.2.4.1.2"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p112301121618"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b213734620">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.5.4.2.4.1.3"><p id="eip_openstackapi_0002__en-us_topic_0201534229_p1323611171617"><strong id="eip_openstackapi_0002__en-us_topic_0201534229_b97191050153010">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_openstackapi_0002__en-us_topic_0201534229_row15260111169"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.4.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p192851171616">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.4.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p122815111167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.4.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p12813117167">Specifies the API link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_openstackapi_0002__en-us_topic_0201534229_row132891118162"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.4.2.4.1.1 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p1728171118161">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.4.2.4.1.2 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p42820114167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.4.2.4.1.3 "><p id="eip_openstackapi_0002__en-us_topic_0201534229_p5289119162">Specifies the relationship between the API link and the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section9470161875517"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="eip_openstackapi_0002__en-us_topic_0201534229_screen14314422468">{
|
|
"versions": [
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v2.0",
|
|
"links": [
|
|
{
|
|
"href": "https://{Endpoint}/v2.0",
|
|
"rel": "self"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="eip_openstackapi_0002__en-us_topic_0201534229_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="eip_openstackapi_0002__en-us_topic_0201534229_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_openstackapi_0002__en-us_topic_0201534229_p7233105282813">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="eip_openstackapi_0001.html">API Version Information</a></div>
|
|
</div>
|
|
</div>
|
|
|