forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
149 lines
10 KiB
HTML
149 lines
10 KiB
HTML
<a name="dcs-api-0312039"></a><a name="dcs-api-0312039"></a>
|
|
|
|
<h1 class="topictitle1">Querying AZ Information</h1>
|
|
<div id="body32903664"><div class="section" id="dcs-api-0312039__section164151825713"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312039__p1650115456387">This API is used to query the ID of the AZ where a DCS instance resides. </p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312039__section11589173274"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312039__p84991845164614">GET /v1.0/availableZones</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312039__section1271822314281"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312039__p1427094363120"><strong id="dcs-api-0312039__b362193885513">Request parameters</strong></p>
|
|
<p id="dcs-api-0312039__p162708434311">None</p>
|
|
<p id="dcs-api-0312039__p1427094312316"><strong id="dcs-api-0312039__b2022574118554">Example request</strong></p>
|
|
<p id="dcs-api-0312039__p4270104310312">None</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312039__section1745154162813"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312039__p62811757144610"><strong id="dcs-api-0312039__b18111174675518">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312039__p12163175373917"><a href="#dcs-api-0312039__table5725353918">Table 1</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312039__table5725353918"></a><a name="table5725353918"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312039__table5725353918" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312039__row1862534399"><th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312039__p2615536391">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312039__p86453163917">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.1%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312039__p196135383919">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312039__row137195353920"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312039__p126953173914">regionId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312039__p197135314392">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312039__p18755363917">Region ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row075534392"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312039__p6715311397">available_zones</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312039__p7755373913">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312039__p3775313395">Array of AZs. For details, see <a href="#dcs-api-0312039__table20901104905614">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312039__table20901104905614"></a><a name="table20901104905614"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312039__table20901104905614" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description of the available_zones array</caption><thead align="left"><tr id="dcs-api-0312039__row12901249155618"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312039__p6686654192615">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312039__p129029492566">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.58585858585859%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312039__p690217494561">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312039__row139022491568"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p1290214497560">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p29021492564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p1990217498567">AZ ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row490216496566"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p2902164995619">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p1902124917569">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p1490212498563">AZ code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row119023498565"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p15902649165614">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p119022492561">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p2902204935616">AZ name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row890204912564"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p79021549175610">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p10902949165614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p17902154925615">Port number of the AZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row1285718223542"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p28591422145411">resource_availability</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p11859172215541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p1219863831719">An indicator of whether there are available Redis 3.0 resources in the AZ.</p>
|
|
<ul id="dcs-api-0312039__ul17198113812171"><li id="dcs-api-0312039__li1199038191712"><strong id="dcs-api-0312039__b137424216583">true</strong>: There are available resources in the AZ.</li><li id="dcs-api-0312039__li1419973811712"><strong id="dcs-api-0312039__b87404251917">false</strong>: There are no available resources in the AZ.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312039__row116391341562"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312039__p1664034195614">resource_availability_dcs2</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312039__p136409411567">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312039__p79641530145613">An indicator of whether there are available Redis 4.0 and 5.0 resources in the AZ.</p>
|
|
<ul id="dcs-api-0312039__ul16964103018569"><li id="dcs-api-0312039__li189659303560"><strong id="dcs-api-0312039__b54171129458">true</strong>: There are available resources in the AZ.</li><li id="dcs-api-0312039__li5965163010564"><strong id="dcs-api-0312039__b012436121014">false</strong>: There are no available resources in the AZ.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="dcs-api-0312039__p1580971064719"><strong id="dcs-api-0312039__b1590619335612">Example response</strong></p>
|
|
</div>
|
|
<pre class="screen" id="dcs-api-0312039__screen029758144218">{
|
|
"regionId": "XXXXXX",
|
|
"available_zones": [
|
|
{
|
|
"id": "f84448fd537f46078dd8bd776747f573",
|
|
"code": "XXXXXX",
|
|
"name": "XXXXXX",
|
|
"port": "8003",
|
|
"resource_availability": "true"
|
|
},
|
|
{
|
|
"id": "12c47a78666b4e438cd0c692b9860387",
|
|
"code": "XXXXXX",
|
|
"name": "XXXXXX",
|
|
"port": "8002",
|
|
"resource_availability": "true"
|
|
},
|
|
{
|
|
"id": "0725858e0d26434f9aa3dc5fc40d5697",
|
|
"code": "XXXXXX",
|
|
"name": "XXXXXX",
|
|
"port": "8009",
|
|
"resource_availability": "true"
|
|
}
|
|
]
|
|
} </pre>
|
|
<div class="section" id="dcs-api-0312039__section9114171291417"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312039__p611571212145"><a href="#dcs-api-0312039__table201151124142">Table 3</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312039__table201151124142"></a><a name="table201151124142"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312039__table201151124142" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312039__row61151912141410"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.6.3.2.3.1.1"><p id="dcs-api-0312039__p18115512151411">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.6.3.2.3.1.2"><p id="dcs-api-0312039__p41151712151419">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312039__row811551251417"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.6.3.2.3.1.1 "><p id="dcs-api-0312039__p17115201211417">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.6.3.2.3.1.2 "><p id="dcs-api-0312039__p16116151214148">AZ information queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312038.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|