vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_0021.html
zhangyue ccbf63b495 EVS API DOC 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-16 09:08:21 +00:00

218 lines
15 KiB
HTML
Raw Blame History

<a name="evs_04_0021"></a><a name="evs_04_0021"></a>
<h1 class="topictitle1">Querying Information of an API Version</h1>
<div id="body1495262661756"><div class="section" id="evs_04_0021__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_0021__p50301879">This API is used to query information of an API version.</p>
</div>
<div class="section" id="evs_04_0021__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_0021__ul47920438"><li id="evs_04_0021__li28630766">URI format<p id="evs_04_0021__p195525020124"><a name="evs_04_0021__li28630766"></a><a name="li28630766"></a>GET /{api_version}</p>
</li><li id="evs_04_0021__li05051003583">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0021__table1713182113123" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0021__row572082112129"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_0021__p117213216122">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_0021__p13722182141217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_0021__p18727112115122">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0021__row672911211121"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_0021__p92913260121">api_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_0021__p20735172151211">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_0021__p34154511106">Specifies the target API version.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_0021__section0879165342510"><h4 class="sectiontitle">Request</h4><ul id="evs_04_0021__ul530017301897"><li id="evs_04_0021__li63006301791">Example request<pre class="screen" id="evs_04_0021__screen411873912920">GET https://{endpoint}/v2</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0021__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_0021__ul45240216"><li id="evs_04_0021__li156383681112">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0021__table1244631181217" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0021__row644717114128"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_0021__p1044711171210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_0021__p1844716114129">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.79%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_0021__p4447510123">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0021__row1244711120123"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0021__p1744719113124">versions</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0021__p74479101218">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0021__p1144717181219">Specifies the API version information. For details, see <a href="#evs_04_0021__li8787321201856">Parameters in the versions field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0021__li8787321201856"><a name="evs_04_0021__li8787321201856"></a><a name="li8787321201856"></a>Parameters in the <strong id="evs_04_0021__b138614242154">versions</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0021__table49541177222812" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0021__row31307356222812"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_0021__p52867918222812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_0021__p54442989222812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_0021__p47079504222812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0021__row49897554222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p31318845143243">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p53798498143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p17769204972711">Specifies the minimum microversion supported. If this version does not support microversions, the value is an empty string.</p>
</td>
</tr>
<tr id="evs_04_0021__row15692876222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p27535301143243">media-types</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p15766871143243">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p31685730143243">Specifies the request message type of the API version. For details, see <a href="#evs_04_0021__li37963683152623">Parameters in the media-types field</a>.</p>
</td>
</tr>
<tr id="evs_04_0021__row54402779222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p13448319143243">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p31184311191352">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p28790367143243">Specifies the URI of the API version. For details, see <a href="#evs_04_0021__li31774851152634">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_0021__row23073040222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p50212078143243">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p40646554143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p58524749143243">Specifies the ID of the API version.</p>
</td>
</tr>
<tr id="evs_04_0021__row52652485222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p50414043143243">updated</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p57005649143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p16367207143243">Specifies the last time when the API version was updated.</p>
<p id="evs_04_0021__p379895311272"><span id="evs_04_0021__text1016171102820">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_0021__row2625553314335"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p35634222143315">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p690833143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p36267691143315">Specifies the maximum microversion supported. If this version does not support microversions, the value is an empty string.</p>
</td>
</tr>
<tr id="evs_04_0021__row3428178414338"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0021__p65363382143315">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0021__p59942555143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0021__p25161763143315">Specifies the API version status. The value can be as follows:</p>
<ul id="evs_04_0021__ul52099355205"><li id="evs_04_0021__li112098358203"><strong id="evs_04_0021__b22215229176">CURRENT</strong>: EVS custom APIs provide multiple versions. For the APIs offering same functions, you are recommended to use the v2 APIs.</li><li id="evs_04_0021__li720973582015"><strong id="evs_04_0021__b780252410167">SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="evs_04_0021__li132096355207"><strong id="evs_04_0021__b3421536151618">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0021__li37963683152623"><a name="evs_04_0021__li37963683152623"></a><a name="li37963683152623"></a>Parameters in the <strong id="evs_04_0021__b842352706145625">media-types</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0021__table1723912303523" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0021__row1572605203523"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_0021__p4956457303630">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_0021__p5530748603630">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_0021__p1479139303630">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0021__row4241971403523"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0021__p1344484103523">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0021__p1529029903523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0021__p5901344603523">Specifies the response type.</p>
</td>
</tr>
<tr id="evs_04_0021__row6135897003523"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0021__p402067503523">base</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0021__p5723929303523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0021__p580387503523">Specifies the text type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0021__li31774851152634"><a name="evs_04_0021__li31774851152634"></a><a name="li31774851152634"></a>Parameters in the <strong id="evs_04_0021__b84235270692535">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0021__table35183803523" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0021__row1099838503523"><th align="left" class="cellrowborder" valign="top" width="22.352235223522353%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_0021__p1845402603523">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.352235223522353%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_0021__p1838114303523">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.295529552955294%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_0021__p405534303523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0021__row3649809103523"><td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0021__p355541903523">rel</p>
</td>
<td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0021__p1955354003523">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.295529552955294%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0021__p4573756603523">Specifies the domain name description.</p>
</td>
</tr>
<tr id="evs_04_0021__row898491303523"><td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0021__p5668937803523">href</p>
</td>
<td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0021__p2843694403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.295529552955294%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0021__p1215177703523">Specifies the domain name.</p>
</td>
</tr>
<tr id="evs_04_0021__row4225713203523"><td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0021__p27570503523">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0021__p2233213403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.295529552955294%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0021__p2248281703523">Specifies the response type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0021__li4508766">Example response<pre class="screen" id="evs_04_0021__screen59436693163550">{
"versions": [
{
"min_version": "",
"media-types": [
{
"type": "application/vnd.openstack.volume+json;version=1",
"base": "application/json"
},
{
"type": "application/vnd.openstack.volume+xml;version=1",
"base": "application/xml"
}
],
"links": [
{
"rel": "describedby",
"href": "http://docs.openstack.org/",
"type": "text/html"
},
{
"rel": "self",
"href": "https://evs.localdomain.com/v2"
}
],
"id": "v2.0",
"updated": "2014-06-28T12:20:21Z",
"version": "",
"status": "SUPPORTED"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0021__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_0021__ul5136981"><li id="evs_04_0021__li46232835">Normal<p id="evs_04_0021__p13442339"><a name="evs_04_0021__li46232835"></a><a name="li46232835"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_0021__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_0021__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_4007.html">API Version Query</a></div>
</div>
</div>
View Git Blame Copy Permalink