doc-exports/docs/vpn/api-ref/vpn_api_1014.html
Hongwei, King Wang 32c06a10a2 vpn_api
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2024-08-15 14:18:28 +00:00

120 lines
14 KiB
HTML

<a name="EN-US_TOPIC_0000001854089245"></a><a name="EN-US_TOPIC_0000001854089245"></a>
<h1 class="topictitle1">Querying API Versions</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section47928120"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p39860200">This API is used to query all available versions of a native OpenStack API.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section28699899"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p33081345111049">GET</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section42990474"><h4 class="sectiontitle">Request Message</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p87111322120">Request parameter</p>
<p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p4775574">None</p>
<p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p49118511121">Example request</p>
<pre class="screen" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_screen173165612148">GET https://{Endpoint}/</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section51369953"><h4 class="sectiontitle">Response Message</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p1760314289129">Response parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table51277242" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row64740644"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p9500791"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b842352706193648">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p31366578"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b842352706193653">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p40344834"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b8423527061645">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row46706151"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p25101909">versions</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p1668082023018">Array of <a href="#EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table7472653181512">version</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p15291872">Specifies the API version list. For details, see <a href="#EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table7472653181512">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table7472653181512"></a><a name="en-us_topic_0000001540977042_en-us_topic_0100582600_table7472653181512"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table7472653181512" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b20193639191119">version</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row24721153191511"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p7472853151518"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b04872545271">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p1647210534155"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_b25585260">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p11472185317150"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b13097052814">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row18472155310158"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p147217533154">status</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p947255320159">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p47752014191">Specifies the API version status. Possible values are as follows:</p>
<ul id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_ul1053872581218"><li id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_li153882516123"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b84235270619587">CURRENT</strong></li><li id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_li453842501212"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b1776824032913">STABLE</strong></li><li id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_li18538152511213"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b1095445010297">DEPRECATED</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row747215312152"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p10472115381512">id</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p9472115313158">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p647375331518">Specifies the API version.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row174734534159"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p18473105321516">links</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p984011365304">Array of <a href="#EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table62331111162">link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p164731253181513">Specifies the link list. For details, see <a href="#EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table62331111162">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table62331111162"></a><a name="en-us_topic_0000001540977042_en-us_topic_0100582600_table62331111162"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_table62331111162" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b330155711111">link</strong> objects</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row1823611191619"><th align="left" class="cellrowborder" valign="top" width="23.122312231223123%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p19231111161619"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b1991194683010">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.552555255525554%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p112301121618"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_b894492807">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.325132513251326%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p1323611171617"><strong id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_b97191050153010">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row15260111169"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p192851171616">href</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p122815111167">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p12813117167">Specifies the API link.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_row132891118162"><td class="cellrowborder" valign="top" width="23.122312231223123%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p1728171118161">rel</p>
</td>
<td class="cellrowborder" valign="top" width="25.552555255525554%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p42820114167">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.325132513251326%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p5289119162">Specifies the relationship between the API link and the API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p102731845181218">Example response</p>
<pre class="screen" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_screen14314422468">{
"versions": [
{
"status": "CURRENT",
"id": "v2.0",
"links": [
{
"href": "https://None/v2.0",
"rel": "self"
}
]
}
]
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section10470352390"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p18112112662914">See <a href="vpn_api_1056.html#EN-US_TOPIC_0000001807370572">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001854089245__en-us_topic_0000001540977042_en-us_topic_0100582600_p7233105282813">See <a href="vpn_api_1055.html#EN-US_TOPIC_0000001807530396">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1013.html">API Version Information</a></div>
</div>
</div>