forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
118 lines
8.9 KiB
HTML
118 lines
8.9 KiB
HTML
<a name="vpc_version_0001"></a><a name="vpc_version_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions</h1>
|
|
<div id="body1520325608860"><div class="section" id="vpc_version_0001__section47928120"><h4 class="sectiontitle">Function</h4><p id="vpc_version_0001__p39860200">This API is used to query all available versions of a native OpenStack API.</p>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section28699899"><h4 class="sectiontitle">URI</h4><p id="vpc_version_0001__p33081345111049">GET /</p>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section42990474"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_version_0001__p4775574">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section167693416553"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_version_0001__screen173165612148">GET https://{Endpoint}/</pre>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section51369953"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0001__table51277242" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="vpc_version_0001__row64740644"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_version_0001__p9500791"><strong id="vpc_version_0001__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="vpc_version_0001__p31366578"><strong id="vpc_version_0001__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="vpc_version_0001__p40344834"><strong id="vpc_version_0001__b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_version_0001__row46706151"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_version_0001__p25101909">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_version_0001__p1668082023018">Array of <a href="#vpc_version_0001__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="vpc_version_0001__p15291872">Specifies the API version list. For details, see <a href="#vpc_version_0001__table7472653181512">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_version_0001__table7472653181512"></a><a name="table7472653181512"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0001__table7472653181512" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="vpc_version_0001__b20193639191119">version</strong> objects</caption><thead align="left"><tr id="vpc_version_0001__row24721153191511"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_version_0001__p7472853151518"><strong id="vpc_version_0001__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="vpc_version_0001__p1647210534155"><strong id="vpc_version_0001__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="vpc_version_0001__p11472185317150"><strong id="vpc_version_0001__b13097052814">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_version_0001__row18472155310158"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0001__p147217533154">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0001__p947255320159">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_version_0001__p47752014191">Specifies the API version status. Possible values are as follows:</p>
|
|
<ul id="vpc_version_0001__ul1053872581218"><li id="vpc_version_0001__li153882516123"><strong id="vpc_version_0001__b84235270619587">CURRENT</strong></li><li id="vpc_version_0001__li453842501212"><strong id="vpc_version_0001__b1776824032913">STABLE</strong></li><li id="vpc_version_0001__li18538152511213"><strong id="vpc_version_0001__b1095445010297">DEPRECATED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_version_0001__row747215312152"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0001__p10472115381512">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0001__p9472115313158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_version_0001__p647375331518">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_version_0001__row174734534159"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_version_0001__p18473105321516">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_version_0001__p984011365304">Array of <a href="#vpc_version_0001__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="vpc_version_0001__p164731253181513">Specifies the link list. For details, see <a href="#vpc_version_0001__table62331111162">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_version_0001__table62331111162"></a><a name="table62331111162"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_version_0001__table62331111162" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="vpc_version_0001__b330155711111">link</strong> objects</caption><thead align="left"><tr id="vpc_version_0001__row1823611191619"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_version_0001__p19231111161619"><strong id="vpc_version_0001__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="vpc_version_0001__p112301121618"><strong id="vpc_version_0001__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="vpc_version_0001__p1323611171617"><strong id="vpc_version_0001__b97191050153010">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_version_0001__row15260111169"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_version_0001__p192851171616">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_version_0001__p122815111167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_version_0001__p12813117167">Specifies the API link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_version_0001__row132891118162"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_version_0001__p1728171118161">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_version_0001__p42820114167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_version_0001__p5289119162">Specifies the relationship between the API link and the API version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section9470161875517"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_version_0001__screen14314422468">{
|
|
"versions": [
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v2.0",
|
|
"links": [
|
|
{
|
|
"href": "https://{Endpoint}/v2.0",
|
|
"rel": "self"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="vpc_version_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_version_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_version_0001__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_version_0000.html">API Version Information</a></div>
|
|
</div>
|
|
</div>
|
|
|