forked from docs/doc-exports
guoyanyan
c311ecafe3
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
153 lines
13 KiB
HTML
153 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0134720582"></a><a name="EN-US_TOPIC_0134720582"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions (Native OpenStack API)</h1>
|
|
<div id="body1539316607899"><div class="section" id="EN-US_TOPIC_0134720582__section54478915181842"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0134720582__p40170843">This interface is used to query all available Nova versions.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0134720582__section53791107181842"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0134720582__p53736847103512">GET /</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0134720582__section39878380181842"><h4 class="sectiontitle">Request Message</h4><ul id="EN-US_TOPIC_0134720582__ul95291934013"><li id="EN-US_TOPIC_0134720582__li0697201274817">Request parameters<p id="EN-US_TOPIC_0134720582__p3650131610485"><a name="EN-US_TOPIC_0134720582__li0697201274817"></a><a name="li0697201274817"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0134720582__li115291834112">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0134720582__screen885564715110"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">GET</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0134720582__section13201080181842"><h4 class="sectiontitle">Response Message</h4><ul id="EN-US_TOPIC_0134720582__ul678511581912"><li id="EN-US_TOPIC_0134720582__li1842325613486">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0134720582__table26246518152631" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0134720582__row29602547152631"><th align="left" class="cellrowborder" valign="top" width="27.889999999999997%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0134720582__p1143665616354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.740000000000002%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0134720582__p11440156143517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.370000000000005%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0134720582__p244212561357">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0134720582__row56174697152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p4445556153516">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p444855610353">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p344911569354">Specifies the list of all API versions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row4615503152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p8452756123518">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p1445545663515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p045585620357">Specifies the version ID, for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row9239644152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p9460175653518">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p14983184716501">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p746525619351">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row19267144531214"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p16283354130">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p13242332181317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p2269104581219">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row113965641213"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p2139956101218">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p824653211138">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p513917563125">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row12929787152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p13468556113518">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p18472756113513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p11474856173511">If the APIs of this version support minor versions, set this parameter to the maximum minor version supported. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row39341340152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p647516561358">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p164801756103517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p104811756113517">Specifies the version status. Possible values are as follows:</p>
|
|
<ul id="EN-US_TOPIC_0134720582__ul4932195311538"><li id="EN-US_TOPIC_0134720582__li12932185315532"><strong id="EN-US_TOPIC_0134720582__b11954152420422">CURRENT</strong>: indicates a primary version.</li><li id="EN-US_TOPIC_0134720582__li4932115355313"><strong id="EN-US_TOPIC_0134720582__b3117229104215">SUPPORTED</strong>: indicates an old version that is still supported.</li><li id="EN-US_TOPIC_0134720582__li7932125320534"><strong id="EN-US_TOPIC_0134720582__b449312382428">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row398200152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p7486145617358">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p34901556173518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p14678111311550">Specifies the version release time, which must be the UTC time.</p>
|
|
<p id="EN-US_TOPIC_0134720582__p24932056163517">For example, the release time of v1 is 2014-06-28T12:20:21Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134720582__row61549520152631"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0134720582__p2495115693510">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0134720582__p134991256203512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.370000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0134720582__p205014565351">If the APIs of this version support minor versions, set this parameter to the supported minimum minor version. If not, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0134720582__li117852587119">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0134720582__screen62654542181842"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
|
|
<span class="normal"> 2</span>
|
|
<span class="normal"> 3</span>
|
|
<span class="normal"> 4</span>
|
|
<span class="normal"> 5</span>
|
|
<span class="normal"> 6</span>
|
|
<span class="normal"> 7</span>
|
|
<span class="normal"> 8</span>
|
|
<span class="normal"> 9</span>
|
|
<span class="normal">10</span>
|
|
<span class="normal">11</span>
|
|
<span class="normal">12</span>
|
|
<span class="normal">13</span>
|
|
<span class="normal">14</span>
|
|
<span class="normal">15</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"versions"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"links"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"rel"</span><span class="p">:</span><span class="w"> </span><span class="s">"self"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"href"</span><span class="p">:</span><span class="w"> </span><span class="s">"https://192.168.82.231:443/v2/"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"id"</span><span class="p">:</span><span class="w"> </span><span class="s">"v2.0"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"updated"</span><span class="p">:</span><span class="w"> </span><span class="s">"2018-09-21T12:33:21Z"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"status"</span><span class="p">:</span><span class="w"> </span><span class="s">"SUPPORTED"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="o">]</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0134720582__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p193201622141412">Normal values
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.3.1.1"><p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p19735204616177">Returned Values</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.3.1.2"><p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p207355465176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p13735144611178">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0134720582__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0134720582__en-us_topic_0106040941_p10243161417491">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0134720581.html">API Version Query</a></div>
|
|
</div>
|
|
</div>
|
|
|