forked from docs/doc-exports
guoyanyan
31704f0318
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
239 lines
17 KiB
HTML
239 lines
17 KiB
HTML
<a name="as_06_1101"></a><a name="as_06_1101"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions</h1>
|
|
<div id="body1537950990993"><div class="section" id="as_06_1101__section11355891"><h4 class="sectiontitle">Function</h4><p class="litext" id="as_06_1101__p19884118">This interface is used to query all API versions of the AS service.</p>
|
|
</div>
|
|
<div class="section" id="as_06_1101__section35094160"><h4 class="sectiontitle">URI</h4><p id="as_06_1101__p73053">GET /</p>
|
|
</div>
|
|
<div class="section" id="as_06_1101__section47411987"><h4 class="sectiontitle">Request Message</h4><ul id="as_06_1101__ul9007507"><li id="as_06_1101__li56913160">Request parameters<p id="as_06_1101__p60400126203515"><a name="as_06_1101__li56913160"></a><a name="li56913160"></a>None</p>
|
|
</li><li id="as_06_1101__li3640858994017">Example request<div class="p" id="as_06_1101__p1555354174019"><a name="as_06_1101__li3640858994017"></a><a name="li3640858994017"></a>This example shows how to query all versions of an API.<pre class="screen" id="as_06_1101__screen17675713402">GET https://{Endpoint}/</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_1101__section24054701"><h4 class="sectiontitle">Response Message</h4><ul id="as_06_1101__ul59560431"><li id="as_06_1101__li66281838">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_1101__table59665636" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="as_06_1101__row28755990"><th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="as_06_1101__p47533853"><strong id="as_06_1101__b992010528465">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.31%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="as_06_1101__p25036876">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.96%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="as_06_1101__p14721100"><strong id="as_06_1101__b9643175312469">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_1101__row34736162"><td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="as_06_1101__p1654215818362">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.31%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="as_06_1101__p2257160">Array of <a href="#as_06_1101__table5036780310489">versions</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.96%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="as_06_1101__p48612303">Specifies the API versions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="as_06_1101__table5036780310489"></a><a name="table5036780310489"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_1101__table5036780310489" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="as_06_1101__b011295285216">versions</strong> field description</caption><thead align="left"><tr id="as_06_1101__r1f3f90a6acc94015acc80b9d6b53f072"><th align="left" class="cellrowborder" valign="top" width="18.67%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="as_06_1101__ad0d15c1370cb450fb7e6011b8baff160">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.23%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="as_06_1101__a2273dfb9dd3341b0b5cbf801a0aa70fc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.10000000000001%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="as_06_1101__a479b45e1fbfc44118151c43b5ecb82f1">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_1101__rdd24623b54f94a86b0f655ec659180e9"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__ab9c8eb8b964943509fca83cc70a4e489">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__a43cc5f338c7e429c861f7dbb2dcb3229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__a5c153a8f0b8d4f26af1405cdcbcec1cc">Specifies the API version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__r784e679e20ef42c7b5f0d9caebb3d506"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__af5650be6710143e49d288b78f41a9c9d">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__aa41878c3fbc74f52be50c47e0dd26a46">Array of <a href="#as_06_1101__t759e6d15d244474e8f286185ede143fb">links</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__a37d79d061a9f47c5beee1f98f4c4611b">Specifies the API URL. For details, see <a href="#as_06_1101__t759e6d15d244474e8f286185ede143fb">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__r06fe5129bbc1493289f623afe4a4f1a2"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__p9107111411399">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__a89734c8a12d44d69ab229cf5857bdf05">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__p19907734114018">Specifies the earliest supported API version number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__rac189e8b65c5430eb4503bf1d1bbb4d7"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__ab5c5c2b93a134f18a2455224014556e9">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__a2de7247f99c143e09e698f0ef82f62bc">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__a65ce06cd4813480498062e1de2541bd3">Specifies the API version status.</p>
|
|
<ul id="as_06_1101__ud3dc362d60f54fc08039ec57e921e5a6"><li id="as_06_1101__lc89f92b4cf2743f586cf48bb5e1933d1"><strong id="as_06_1101__b52752029175412">CURRENT</strong>: indicates a primary version.</li><li id="as_06_1101__lb288548ff6554efab07248d038789b1f"><strong>SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="as_06_1101__lb5c451d60e5e417cafd202ef4ca3389f"><strong id="as_06_1101__b250813045513">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__r4dfedc0bd4ff45f2ac05364f99f01708"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__a306f2c2ef05e47f78c5e0fc5440cea3c">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__a979f525a997c4d1e8808195ca9d7f53e">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__p1255911034615">Specifies the release date of an API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__r45a3cc4c3f6943639ac3843c688f6865"><td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_1101__a52a9f640ec724f40a4829ddf066e0837">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_1101__a015154a0e4094475a717b23650fa6cf1">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.10000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_1101__adefe07f521ca4e0aab9007ea28bebc7d">Specifies the latest supported API version number.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="as_06_1101__t759e6d15d244474e8f286185ede143fb"></a><a name="t759e6d15d244474e8f286185ede143fb"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_1101__t759e6d15d244474e8f286185ede143fb" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="as_06_1101__b8470122404716">links</strong> field description</caption><thead align="left"><tr id="as_06_1101__rce98b9668cd747c88039421afe5ce935"><th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="as_06_1101__ad9ac3007570a4752b2b2dbc0fb04dadc">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.23%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="as_06_1101__a602246198adf4a79a13bc4317d4c0d4f">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.09%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="as_06_1101__a8cbfa8dcb0b943ff8e789755123fec83">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_1101__r43de461181294c56b28da56a1f604b09"><td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_1101__abc19a41a8f594f1ba6701e10da50a078">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_1101__a15ae7b8585d24e48abc6b9bf45636fda">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.09%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_1101__p139393206480">Specifies the API Uniform Resource Locator (URL).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__rbd5ec7242fef4c03b21636ac14160d9e"><td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_1101__a18479f6b70b34f29b2b90d754f59282a">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_1101__ae1f14fa2e6a54531aeffd26874fea267">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.09%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_1101__p115877381483">Specifies the API URL dependency.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="as_06_1101__ul45282433"><li id="as_06_1101__li4888719">Example response<pre class="screen" id="as_06_1101__screen1850152295218">{
|
|
"versions": [
|
|
{
|
|
"id": "v1",
|
|
"links": [
|
|
{
|
|
"href": "https://as.XXX.mycloud.com/autoscaling-api/v1/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2016-06-30T00:00:00Z",
|
|
"version": ""
|
|
},
|
|
{
|
|
"id": "v2",
|
|
"links": [
|
|
{
|
|
"href": "https://as.XXX.mycloud.com/autoscaling-api/v2/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "SUPPORTED",
|
|
"updated": "2018-03-30T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
]
|
|
}
|
|
</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_1101__section15165719"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_1101__ul58200784"><li id="as_06_1101__li54045009">Normal<p id="as_06_1101__p16643039"><a name="as_06_1101__li54045009"></a><a name="li54045009"></a>200</p>
|
|
</li><li id="as_06_1101__li15569626">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_1101__table5908907" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_1101__row16065622"><th align="left" class="cellrowborder" valign="top" width="44.17%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="as_06_1101__p26246992">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.83%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="as_06_1101__p45631627">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_1101__row5174319"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p16466658">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p58730959">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row58816586"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p66523006">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p19654399">You must enter the username and password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row42671863"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p33868885">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p59025204">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row61464796"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p12592542">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p13362997">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row53158116"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p10840149">405 Method Not Allowed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p5636878">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row50731910"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p15644031">406 Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p59206997">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row63100926"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p10901353">407 Proxy Authentication Required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p10594405">You must use the proxy server for authentication to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row28240785"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p5802216">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p217508">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row1957580"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p24346266">409 Conflict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p25890496">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row31687876"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p16581154">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p896237">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row8066134"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p49377135">501 Not Implemented</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p40124968">Failed to complete the request because the server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row25580392"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p58745844">502 Bad Gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p60792949">Failed to complete the request because the request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row10265637"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p26210288">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p42658596">Failed to complete the request because the system is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_1101__row48383044"><td class="cellrowborder" valign="top" width="44.17%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_1101__p26712487">504 Gateway Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.83%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_1101__p16227847">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_1101__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_1101__p172692548116">See <a href="as_07_0102.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="as_06_1100.html">API Version Query</a></div>
|
|
</div>
|
|
</div>
|
|
|