forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
170 lines
15 KiB
HTML
170 lines
15 KiB
HTML
<a name="mrs_02_1089"></a><a name="mrs_02_1089"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Health Status of a Specified Cluster</h1>
|
|
<div id="body8662426"><div class="section" id="mrs_02_1089__en-us_topic_0125376271_section1095111617176"><h4 class="sectiontitle">Function </h4><p id="mrs_02_1089__en-us_topic_0125376271_p96995355214">This API is used to query the health status of a specified cluster. If any component is unavailable, the abnormal cluster health status is returned.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_1089__en-us_topic_0125376271_sa3d698e673b8473abff8e652e459e452"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_1089__en-us_topic_0125376271_ul11809202516227"><li id="mrs_02_1089__en-us_topic_0125376271_li14808162582216">Format</li></ul>
|
|
<p class="MsoNormal" id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p37463366">GET /web/v1/cluster/{cluster_id}/status</p>
|
|
<ul id="mrs_02_1089__en-us_topic_0125376271_ul169401440172214"><li id="mrs_02_1089__en-us_topic_0125376271_li29402405229">Parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_table18439633" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row33864059"><th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.2.5.1.4.1.1"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p58634288"><strong id="mrs_02_1089__b162774213314533_1">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.2.5.1.4.1.2"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p51756910">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.08%" id="mcps1.3.2.5.1.4.1.3"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p43854424"><strong id="mrs_02_1089__b842352706134712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row62547480"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p33181137">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p3317546">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p3292018">Cluster ID that is displayed on MRS Manager. The default cluster ID is <strong id="mrs_02_1089__b842352706152828">1</strong>, because MRS Manager supports management of only one cluster currently.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_1089__en-us_topic_0125376271_sf0cd952c6bd6463fa25bee292cda2f7d"><h4 class="sectiontitle">Request</h4><ul id="mrs_02_1089__en-us_topic_0125376271_ul1183102110245"><li id="mrs_02_1089__en-us_topic_0125376271_li17835213248">Example:<pre class="screen" id="mrs_02_1089__en-us_topic_0125376271_screen5597742182412">GET /web/v1/cluster/{cluster_id}/status HTTP/1.1
|
|
Host: example.com
|
|
Content-Type: application/json
|
|
Accept:application/json</pre>
|
|
</li><li class="MsoNormal" id="mrs_02_1089__en-us_topic_0125376271_li15222752152412">Parameter description<p id="mrs_02_1089__en-us_topic_0125376271_p85330182517"><a name="mrs_02_1089__en-us_topic_0125376271_li15222752152412"></a><a name="en-us_topic_0125376271_li15222752152412"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_1089__en-us_topic_0125376271_section8372686259"><h4 class="sectiontitle">Response</h4><ul id="mrs_02_1089__en-us_topic_0125376271_ul149911919192518"><li id="mrs_02_1089__en-us_topic_0125376271_li49901193251">Example:<pre class="screen" id="mrs_02_1089__en-us_topic_0125376271_screen2632204115254">HTTP/1.1 200 OK
|
|
Data:Wed,02 May 2018 10:10:01 GMT
|
|
Server: example-server
|
|
Content-Type: application/json
|
|
{
|
|
"id": 0,
|
|
"state": "COMPLETE",
|
|
"error_code": 0,
|
|
"error_description": "string",
|
|
"total_progress": 0,
|
|
"res_obj": {
|
|
"state": "GOOD"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="mrs_02_1089__en-us_topic_0125376271_ul142219652615"><li class="TableDescription" id="mrs_02_1089__en-us_topic_0125376271_li94221164268">Parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_table1075086" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row9697883"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.6.2.5.1.1"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p47331035"><strong id="mrs_02_1089__b449127703">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.6.2.5.1.2"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p8608636">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.6.2.5.1.3"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p26210917"><strong id="mrs_02_1089__b136233170951630">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.6.2.5.1.4"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p37967333"><strong id="mrs_02_1089__b412735313">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row55455104"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p62678444">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p43789200">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p57264341">LONG</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p24297719">Asynchronous task ID (meaningless in other scenarios). The default value is <strong id="mrs_02_1089__b842352706191850">-1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row17352883"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p63406273">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p35634492">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p712715">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p20028947">Cluster status. The value <strong id="mrs_02_1089__b842352706191926">FAILED</strong> indicates that the command fails to be executed. The value <strong id="mrs_02_1089__b842352706191940">COMPLETE</strong> indicates that the command is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row46042798"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p38479195">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p29807080">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p65563261">INTEGER</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p16049536">Error code returned</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row10228104"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p23170058">error_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p64835425">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p17178101">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p60234923">Error code description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row5243399"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p22062154">total_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p42204021">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p63082545">FLOAT</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p15374808">Total progress</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row4155545"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p1054870">res_obj</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p18335664">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.6.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p8793806">REFERENCE</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.6.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p44201211">Response object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_table23528308" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="mrs_02_1089__b842352706193831">res_obj</strong> parameter description</caption><thead align="left"><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row52992545"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.7.2.5.1.1"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p64537776"><strong id="mrs_02_1089__b814711721">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.7.2.5.1.2"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p60177363">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.7.2.5.1.3"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p42528243"><strong id="mrs_02_1089__b95454036451630">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.7.2.5.1.4"><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p60468685"><strong id="mrs_02_1089__b2084335791">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_row66125294"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.7.2.5.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p54548629">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.7.2.5.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p56362791">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.7.2.5.1.3 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p1983374">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.7.2.5.1.4 "><p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p56146472">Cluster health status</p>
|
|
<p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p35556202"><strong id="mrs_02_1089__b842352706193848">Good</strong>: The cluster is healthy.</p>
|
|
<p id="mrs_02_1089__en-us_topic_0125376271_en-us_topic_0110839913_p51570366"><strong id="mrs_02_1089__b842352706194221">Bad</strong>: The cluster is unhealthy.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="mrs_02_1089__en-us_topic_0125376271_section2092982712508"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1089__en-us_topic_0125376271_table2979011121511" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1089__en-us_topic_0125376271_row3981161161515"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.8.2.1.3.1.1"><p id="mrs_02_1089__en-us_topic_0125376271_p398115116158">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="83%" id="mcps1.3.8.2.1.3.1.2"><p id="mrs_02_1089__en-us_topic_0125376271_p1798121191515">Description </p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1089__en-us_topic_0125376271_row69813112155"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.8.2.1.3.1.1 "><p id="mrs_02_1089__en-us_topic_0125376271_p15667142018546">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83%" headers="mcps1.3.8.2.1.3.1.2 "><p id="mrs_02_1089__en-us_topic_0125376271_p23378286542">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_1089__en-us_topic_0125376271_p385511715205">For details about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_1086.html">MRS Manager Web APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|