forked from docs/doc-exports
Chen, Junjie
7f68b84da4
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>
143 lines
12 KiB
HTML
143 lines
12 KiB
HTML
<a name="kafka-api-180514008"></a><a name="kafka-api-180514008"></a>
|
|
|
|
<h1 class="topictitle1">Querying AZ Information</h1>
|
|
<div id="body1524661275118"><div class="note" id="kafka-api-180514008__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514008__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="ListAvailableZones.html">Listing AZ Information</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180514008__section1073032015911"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514008__p72861071807">This API is used to query the AZ ID.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514008__en-us_topic_0128036911_section023216425361"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514008__en-us_topic_0128036911_p9337194218369">GET /v1.0/availableZones</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514008__en-us_topic_0128036911_section11232742133616"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514008__en-us_topic_0128036911_p17337194263615"><strong id="kafka-api-180514008__en-us_topic_0128036911_b379215362319">Request parameters</strong></p>
|
|
<p id="kafka-api-180514008__en-us_topic_0128036911_p16337342163619">None.</p>
|
|
<p id="kafka-api-180514008__en-us_topic_0128036911_p6337194233613"><strong id="kafka-api-180514008__en-us_topic_0128036911_b57457391338">Example request</strong></p>
|
|
<pre class="screen" id="kafka-api-180514008__screen1493374814613">GET https://{dms_endpoint}/v1.0/availableZones</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514008__en-us_topic_0128036911_section16232164233620"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514008__en-us_topic_0128036911_p10337174213365"><strong id="kafka-api-180514008__en-us_topic_0128036911_b1693219421631">Response parameters</strong></p>
|
|
<p id="kafka-api-180514008__en-us_topic_0128036911_p233819423365"><a href="#kafka-api-180514008__en-us_topic_0128036911_table2233942133618">Table 1</a> and <a href="#kafka-api-180514008__en-us_topic_0128036911_table1124311429360">Table 2</a> describe the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514008__en-us_topic_0128036911_table2233942133618"></a><a name="en-us_topic_0128036911_table2233942133618"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514008__en-us_topic_0128036911_table2233942133618" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514008__en-us_topic_0128036911_row2033834243618"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514008__en-us_topic_0128036911_p43381342103617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514008__en-us_topic_0128036911_p133815422366">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514008__en-us_topic_0128036911_p333804203617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514008__en-us_topic_0128036911_row4338154217363"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p63381842123617">region_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p14338184253613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1338342193611">Indicates the region ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row11338942173613"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p133382042133614">available_zones</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p10338342103612">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p2033818429368">Indicates details of AZs. For details, see <a href="#kafka-api-180514008__en-us_topic_0128036911_table1124311429360">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514008__en-us_topic_0128036911_table1124311429360"></a><a name="en-us_topic_0128036911_table1124311429360"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514008__en-us_topic_0128036911_table1124311429360" frame="border" border="1" rules="all"><caption><b>Table 2 </b>available_zones parameter description</caption><thead align="left"><tr id="kafka-api-180514008__en-us_topic_0128036911_row153391342163613"><th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180514008__en-us_topic_0128036911_p1033904212362">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180514008__en-us_topic_0128036911_p133391942203617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.62%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180514008__en-us_topic_0128036911_p5339134263615">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514008__row371662714157"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__p68509416130">soldOut</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__p6851142136">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__p1851164101312">Indicates whether resources are sold out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row1433920421369"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p23391425367">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p193391142113619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p033964216368">Indicates the ID of an AZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row163399426369"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p143391242163613">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p10339124293616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p12339842193616">Indicates the code of an AZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row3339194219367"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p17339104273614">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1033964218367">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1333913425367">Indicates the name of an AZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row1339164213368"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1733974216368">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1733984263620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p43391842153613">Indicates the port number of an AZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514008__en-us_topic_0128036911_row9339104283613"><td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p03391442173616">resource_availability</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1833914273613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.62%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1133924211367">Indicates whether an AZ has available resources.</p>
|
|
<ul id="kafka-api-180514008__en-us_topic_0128036911_ul14339124273615"><li id="kafka-api-180514008__en-us_topic_0128036911_li433954211366"><strong id="kafka-api-180514008__en-us_topic_0128036911_b123191342313">true</strong>: The AZ has available resources.</li><li id="kafka-api-180514008__en-us_topic_0128036911_li1733914215365"><strong id="kafka-api-180514008__en-us_topic_0128036911_b522523693114">false</strong>: Resources of the AZ have been sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514008__en-us_topic_0128036911_p83401242143611"><strong id="kafka-api-180514008__en-us_topic_0128036911_b1268515128518">Example response</strong></p>
|
|
<pre class="screen" id="kafka-api-180514008__en-us_topic_0128036911_screen2034084293617">{
|
|
regionId: "XXXX",
|
|
available_zones:[
|
|
{
|
|
"id":"1d7b939b382c4c3bb3481a8ca10da768",
|
|
"name":"az10.dc1",
|
|
"code":"az10.dc1",
|
|
"port":"8002",
|
|
"resource_availability": "true"
|
|
},
|
|
{
|
|
"id":"1d7b939b382c4c3bb3481a8ca10da769",
|
|
"name":"az10.dc2",
|
|
"code":"az10.dc2",
|
|
"port":"8002",
|
|
"resource_availability": "true"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514008__en-us_topic_0128036911_section19258742123617"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514008__en-us_topic_0128036911_p834084253614"><a href="#kafka-api-180514008__en-us_topic_0128036911_table825911423368">Table 3</a> describes the status code of successful operations. For details about other status codes, see <a href="kafka-api-0034672261.html">Status Code</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514008__en-us_topic_0128036911_table825911423368"></a><a name="en-us_topic_0128036911_table825911423368"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514008__en-us_topic_0128036911_table825911423368" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514008__en-us_topic_0128036911_row1234174211367"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514008__en-us_topic_0128036911_p834194213610">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.85000000000001%" id="mcps1.3.6.3.2.3.1.2"><p id="kafka-api-180514008__en-us_topic_0128036911_p16341542163614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514008__en-us_topic_0128036911_row1334174273613"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514008__en-us_topic_0128036911_p143411242133620">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514008__en-us_topic_0128036911_p1334114211361">The AZ information is successfully queried.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-api-190605002.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|