vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_0020.html
zhangyue f3b09e5d2f Elastic Volume Service API V1 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-02 16:28:20 +00:00

257 lines
16 KiB
HTML
Raw Blame History

<a name="evs_04_0020"></a><a name="evs_04_0020"></a>
<h1 class="topictitle1">Querying Information of API Versions</h1>
<div id="body1495261894249"><div class="section" id="evs_04_0020__section19390540"><h4 class="sectiontitle">Function</h4><p id="evs_04_0020__p50301879">This API is used to query information of API versions.</p>
</div>
<div class="section" id="evs_04_0020__section40297137"><h4 class="sectiontitle">URI</h4><ul id="evs_04_0020__ul47920438"><li id="evs_04_0020__li28630766">URI format<p id="evs_04_0020__p37390672"><a name="evs_04_0020__li28630766"></a><a name="li28630766"></a>GET /</p>
</li></ul>
</div>
<div class="section" id="evs_04_0020__section27129916"><h4 class="sectiontitle">Request</h4><ul id="evs_04_0020__ul530017301897"><li id="evs_04_0020__li63006301791">Example request<pre class="screen" id="evs_04_0020__screen411873912920">GET https://{endpoint}/</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0020__section42842654"><h4 class="sectiontitle">Response</h4><ul id="evs_04_0020__ul45240216"><li id="evs_04_0020__li156383681112">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0020__table1244631181217" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0020__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_0020__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_0020__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_0020__p4447510123">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0020__row1244711120123"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0020__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_0020__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_0020__p1144717181219">Specifies the API versions. For details, see <a href="#evs_04_0020__li8787321201856">Parameters in the versions field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0020__li8787321201856"><a name="evs_04_0020__li8787321201856"></a><a name="li8787321201856"></a>Parameters in the <strong id="evs_04_0020__b4853152121116">versions</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0020__table49541177222812" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0020__row31307356222812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_0020__p52867918222812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_0020__p54442989222812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.81999999999999%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_0020__p47079504222812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0020__row49897554222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p31318845143243">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p53798498143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__p46434022143243">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_0020__row15692876222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p27535301143243">media-types</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p15766871143243">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__p31685730143243">Specifies the request message type of the API version. For details, see <a href="#evs_04_0020__li16162726152446">Parameters in the media-types field</a>.</p>
</td>
</tr>
<tr id="evs_04_0020__row54402779222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p13448319143243">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p3173993219137">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__p28790367143243">Specifies the URI of the API version. For details, see <a href="#evs_04_0020__li2542907152450">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_0020__row23073040222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p50212078143243">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p40646554143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__p58524749143243">Specifies the ID of the API version.</p>
</td>
</tr>
<tr id="evs_04_0020__row52652485222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p50414043143243">updated</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p57005649143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__p16367207143243">Specifies the last time when the API version was updated.</p>
<p id="evs_04_0020__p2841328201815"><span id="evs_04_0020__text11514509197">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_0020__row2625553314335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p35634222143315">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p690833143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0020__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_0020__row3428178414338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0020__p65363382143315">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0020__p59942555143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_0020__p25161763143315">Specifies the API version status. The value can be as follows:<ul id="evs_04_0020__ul52099355205"><li id="evs_04_0020__li112098358203"><strong id="evs_04_0020__b1487242091615">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_0020__li720973582015"><strong id="evs_04_0020__b8470857123214">SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="evs_04_0020__li132096355207"><strong id="evs_04_0020__b1447319585329">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0020__li16162726152446"><a name="evs_04_0020__li16162726152446"></a><a name="li16162726152446"></a>Parameters in the <strong id="evs_04_0020__b3412125953220">media-types</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0020__table1723912303523" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0020__row1572605203523"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_0020__p4956457303630">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_0020__p5530748603630">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.81999999999999%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_0020__p1479139303630">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0020__row4241971403523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0020__p1344484103523">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0020__p1529029903523">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0020__p5901344603523">Specifies the response type.</p>
</td>
</tr>
<tr id="evs_04_0020__row6135897003523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0020__p402067503523">base</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0020__p5723929303523">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.81999999999999%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0020__p580387503523">Specifies the text type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_0020__ul62524494152450"><li id="evs_04_0020__li2542907152450"><a name="evs_04_0020__li2542907152450"></a><a name="li2542907152450"></a>Parameters in the <strong id="evs_04_0020__b261817093314">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0020__table35183803523" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0020__row1099838503523"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_0020__p1845402603523">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_0020__p1838114303523">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.65%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_0020__p405534303523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0020__row3649809103523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_0020__p355541903523">rel</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_0020__p1955354003523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_0020__p4573756603523">Specifies the domain name description.</p>
</td>
</tr>
<tr id="evs_04_0020__row898491303523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_0020__p5668937803523">href</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_0020__p2843694403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_0020__p1215177703523">Specifies the domain name.</p>
</td>
</tr>
<tr id="evs_04_0020__row4225713203523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_0020__p27570503523">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_0020__p2233213403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_0020__p2248281703523">Specifies the response type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_0020__ul1231321603547"><li id="evs_04_0020__li4508766">Example response<pre class="screen" id="evs_04_0020__screen25455828224845">{
"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/v1"
}
],
"id": "v1.0",
"updated": "2014-06-28T12:20:21Z",
"version": "",
"status": "SUPPORTED"
},
{
"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"
},
{
"min_version": "3.0",
"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/v3"
}
],
"id": "v3.0",
"updated": "2016-02-08T12:20:21Z",
"version": "3.0",
"status": "CURRENT"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0020__section50039568"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_0020__ul5136981"><li id="evs_04_0020__li46232835">Normal<p id="evs_04_0020__p13442339"><a name="evs_04_0020__li46232835"></a><a name="li46232835"></a>300</p>
</li></ul>
</div>
<div class="section" id="evs_04_0020__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_0020__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_0019.html">API Version Query</a></div>
</div>
</div>
View Git Blame Copy Permalink