forked from docs/doc-exports
zhangyue
ccbf63b495
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>
161 lines
11 KiB
HTML
161 lines
11 KiB
HTML
<a name="evs_04_2081"></a><a name="evs_04_2081"></a>
|
|
|
|
<h1 class="topictitle1">Querying All AZs</h1>
|
|
<div id="body34097968"><div class="section" id="evs_04_2081__section54465313"><h4 class="sectiontitle">Function</h4><p id="evs_04_2081__p10472004">This API is used to query all AZs.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_2081__section20425774"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2081__ul42925989"><li id="evs_04_2081__li50789581">URI format<p id="evs_04_2081__p20315403"><a name="evs_04_2081__li50789581"></a><a name="li50789581"></a>GET /v2/{project_id}/os-availability-zone</p>
|
|
</li><li id="evs_04_2081__li48620907">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2081__table34934986" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2081__row15816986"><th align="left" class="cellrowborder" valign="top" width="27.88278827882788%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2081__p6107499">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.81258125812581%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2081__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_2081__p2298151112569">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2081__row55443761"><td class="cellrowborder" valign="top" width="27.88278827882788%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2081__p61759636">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2081__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_2081__p1651899">The project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2081__section49614245"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2081__ul14963212101"><li id="evs_04_2081__li12496526109">Example request<pre class="screen" id="evs_04_2081__screen1016954371312">GET https://{endpoint}/v2/{project_id}/os-availability-zone</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2081__section43875021"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2081__ul33585220"><li id="evs_04_2081__li71431918255">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2081__table201437992512" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2081__p16144994250">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_2081__p01441910254">The list of queried AZs. For details, see <a href="#evs_04_2081__li19751007201910">Parameters in the availabilityZoneInfo field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="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_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_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_2081__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2081__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2081__li19751007201910"><a name="evs_04_2081__li19751007201910"></a><a name="li19751007201910"></a>Parameters in the <strong id="evs_04_2081__b0416121214511">availabilityZoneInfo</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2081__table43541335201910" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2081__p42702004201910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_2081__p44081575201910">The AZ status. For details, see <a href="#evs_04_2081__li11149334112511">Parameter in the zoneState field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="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_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_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_2081__p58856323201910">The AZ name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2081__li11149334112511"><a name="evs_04_2081__li11149334112511"></a><a name="li11149334112511"></a>Parameter in the <strong id="evs_04_2081__b14928102112466">zoneState</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2081__table915023482516" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2081__p1215014346259">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_2081__p171501234112510">Whether the AZ is available.<ul id="evs_04_2081__ul315013410258"><li id="evs_04_2081__li14150834112513"><strong id="evs_04_2081__b43493744616">true</strong>: available</li><li id="evs_04_2081__li415093442516"><strong id="evs_04_2081__b643617390464">false</strong>: unavailable</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2081__li0419202382514"><a name="evs_04_2081__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2081__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2081__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2081__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_2081__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="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_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_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_2081__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="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_2081__li33831530">Example response<pre class="screen" id="evs_04_2081__screen53565719151628">{
|
|
"availabilityZoneInfo": [
|
|
{
|
|
"zoneState": {
|
|
"available": true
|
|
},
|
|
"zoneName": "az-dc-1"
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="evs_04_2081__p29990828">or</p>
|
|
<pre class="screen" id="evs_04_2081__screen23862446151656">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2081__section59330872"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2081__ul3241099"><li id="evs_04_2081__li29169897">Normal<p id="evs_04_2081__p61202487"><a name="evs_04_2081__li29169897"></a><a name="li29169897"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2081__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2081__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_4003.html">AZ Query</a></div>
|
|
</div>
|
|
</div>
|
|
|