forked from docs/doc-exports
zhangyue
f3b09e5d2f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
161 lines
12 KiB
HTML
161 lines
12 KiB
HTML
<a name="evs_04_3045"></a><a name="evs_04_3045"></a>
|
|
|
|
<h1 class="topictitle1">Querying All AZs</h1>
|
|
<div id="body1521536202678"><div class="section" id="evs_04_3045__section54465313"><h4 class="sectiontitle">Function</h4><p id="evs_04_3045__p10472004">This API is used to query all AZs.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_3045__section20425774"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3045__ul42925989"><li id="evs_04_3045__li50789581">URI format<p id="evs_04_3045__p2957181295719"><a name="evs_04_3045__li50789581"></a><a name="li50789581"></a>GET /v3/{project_id}/os-availability-zone</p>
|
|
</li><li id="evs_04_3045__li48620907">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3045__table34934986" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3045__row15816986"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_3045__p6107499">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.362036203620363%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_3045__p24945412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.30463046304631%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_3045__p7312526">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3045__row55443761"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3045__p61759636">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.362036203620363%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3045__p36474591">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.30463046304631%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_3045__p1651899">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3045__section49614245"><h4 class="sectiontitle">Request</h4><ul id="evs_04_3045__ul14963212101"><li id="evs_04_3045__li12496526109">Example request<pre class="screen" id="evs_04_3045__screen1016954371312">GET https://{endpoint}/v3/{project_id}/os-availability-zone</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3045__section43875021"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3045__evs_04_2081_ul33585220"><li id="evs_04_3045__evs_04_2081_li71431918255">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3045__evs_04_2081_table201437992512" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3045__evs_04_2081_row1414420917255"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_3045__evs_04_2081_p11144139152511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_3045__evs_04_2081_p1014419152512">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_3045__evs_04_2081_p16144994250">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3045__evs_04_2081_row181446912510"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_p13144119162511">availabilityZoneInfo</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_p214416911255">list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_p01441910254">Specifies the list of queried AZs. For details, see <a href="#evs_04_3045__evs_04_2081_li19751007201910">Parameters in the availabilityZoneInfo field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3045__evs_04_2081_row6109186192812"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_3045__evs_04_2081_li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3045__evs_04_2081_li19751007201910"><a name="evs_04_3045__evs_04_2081_li19751007201910"></a><a name="evs_04_2081_li19751007201910"></a>Parameters in the <strong id="evs_04_3045__evs_04_2081_b0416121214511">availabilityZoneInfo</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3045__evs_04_2081_table43541335201910" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3045__evs_04_2081_row45002232201910"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_3045__evs_04_2081_p21302142201910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_3045__evs_04_2081_p523569515640">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_3045__evs_04_2081_p42702004201910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3045__evs_04_2081_row36310324201910"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_p55455149201910">zoneState</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_p2143812515640">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_p44081575201910">Specifies the status of the AZ. For details, see <a href="#evs_04_3045__evs_04_2081_li11149334112511">Parameter in the zoneState field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3045__evs_04_2081_row61189858201910"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_p57431491201910">zoneName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_p5876653115640">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_p58856323201910">Specifies the AZ name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3045__evs_04_2081_li11149334112511"><a name="evs_04_3045__evs_04_2081_li11149334112511"></a><a name="evs_04_2081_li11149334112511"></a>Parameter in the <strong id="evs_04_3045__evs_04_2081_b14928102112466">zoneState</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3045__evs_04_2081_table915023482516" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3045__evs_04_2081_row4150434152517"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_3045__evs_04_2081_p1215093419253">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_3045__evs_04_2081_p3150193412259">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_3045__evs_04_2081_p1215014346259">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3045__evs_04_2081_row2150534192516"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_p115073413258">available</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_p915013462516">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><div class="p" id="evs_04_3045__evs_04_2081_p171501234112510">Specifies whether the AZ is available.<ul id="evs_04_3045__evs_04_2081_ul315013410258"><li id="evs_04_3045__evs_04_2081_li14150834112513"><strong id="evs_04_3045__evs_04_2081_b43493744616">true</strong>: available</li><li id="evs_04_3045__evs_04_2081_li415093442516"><strong id="evs_04_3045__evs_04_2081_b643617390464">false</strong>: unavailable</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3045__evs_04_2081_li0419202382514"><a name="evs_04_3045__evs_04_2081_li0419202382514"></a><a name="evs_04_2081_li0419202382514"></a>Parameters in the <strong id="evs_04_3045__evs_04_2081_evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3045__evs_04_2081_evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3045__evs_04_2081_evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_3045__evs_04_2081_evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_3045__evs_04_2081_evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_3045__evs_04_2081_evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_3045__evs_04_2081_evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_3045__evs_04_2081_evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_3045__evs_04_2081_evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_3045__evs_04_2081_evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_3045__evs_04_2081_li33831530">Example response<pre class="screen" id="evs_04_3045__evs_04_2081_screen53565719151628">{
|
|
"availabilityZoneInfo": [
|
|
{
|
|
"zoneState": {
|
|
"available": true
|
|
},
|
|
"zoneName": "az-dc-1"
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="evs_04_3045__evs_04_2081_p29990828">or</p>
|
|
<pre class="screen" id="evs_04_3045__evs_04_2081_screen23862446151656">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3045__section59330872"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3045__evs_04_2081_ul3241099"><li id="evs_04_3045__evs_04_2081_li29169897">Normal<p id="evs_04_3045__evs_04_2081_p61202487"><a name="evs_04_3045__evs_04_2081_li29169897"></a><a name="evs_04_2081_li29169897"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_3045__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3045__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_3028.html">EVS Disk</a></div>
|
|
</div>
|
|
</div>
|
|
|