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>
203 lines
16 KiB
HTML
203 lines
16 KiB
HTML
<a name="mrs_02_1097"></a><a name="mrs_02_1097"></a>
|
|
|
|
<h1 class="topictitle1">Querying Summary of a Specified Service</h1>
|
|
<div id="body8662426"><div class="section" id="mrs_02_1097__en-us_topic_0125376218_section1693516137279"><h4 class="sectiontitle">Function </h4><p class="MsoNormal" id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p11403383">This API is used to query summary of a specified service in a cluster.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_1097__en-us_topic_0125376218_s09ba7354a86545728a5453aab70db875"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_1097__en-us_topic_0125376218_ul750363132719"><li id="mrs_02_1097__en-us_topic_0125376218_li450313318279">Format</li></ul>
|
|
<p class="MsoNormal" id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p19824307">GET /web/v1/cluster/{cluster_id}/services/{service_name}</p>
|
|
<ul id="mrs_02_1097__en-us_topic_0125376218_ul445715421277"><li class="TableDescription" id="mrs_02_1097__en-us_topic_0125376218_li10457124211275">URI parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_table62265016" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_row65147869"><th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.2.5.1.4.1.1"><p id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p42486052"><strong id="mrs_02_1097__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_1097__en-us_topic_0125376218_en-us_topic_0110839921_p18818216">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_1097__en-us_topic_0125376218_en-us_topic_0110839921_p8067764">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_row49509118"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p50815604">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_1097__en-us_topic_0125376218_en-us_topic_0110839921_p22423296">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p31441817">Cluster ID that is displayed on MRS Manager. The default cluster ID is <strong id="mrs_02_1097__b842352706152828">1</strong>, because MRS Manager supports management of only one cluster currently.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_row14540903"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p36962494">service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_en-us_topic_0110839921_p41172029">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p42313610163">Name of the service to be queried.</p>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_p8148103217165">For example, the service name is HBase, HDFS, or Spark.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_1097__en-us_topic_0125376218_s4ef085a1c7a74029bfce22258f6077a6"><h4 class="sectiontitle">Request</h4><ul id="mrs_02_1097__en-us_topic_0125376218_ul12417102292813"><li id="mrs_02_1097__en-us_topic_0125376218_li184176223289">Example:<pre class="screen" id="mrs_02_1097__en-us_topic_0125376218_screen125914113288">GET /web/v1/cluster/{cluster_id}/services/{service_name} HTTP/1.1
|
|
Host: example.com
|
|
Content-Type: application/json
|
|
Accept:application/json</pre>
|
|
</li><li class="MsoNormal" id="mrs_02_1097__en-us_topic_0125376218_li636374616280">Parameter description<p id="mrs_02_1097__en-us_topic_0125376218_p14742208298"><a name="mrs_02_1097__en-us_topic_0125376218_li636374616280"></a><a name="en-us_topic_0125376218_li636374616280"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_1097__en-us_topic_0125376218_section1560865371016"><h4 class="sectiontitle">Response</h4><ul id="mrs_02_1097__en-us_topic_0125376218_ul1733123642616"><li id="mrs_02_1097__en-us_topic_0125376218_li18331636142615">Example:<pre class="screen" id="mrs_02_1097__en-us_topic_0125376218_screen1761511513148">HTTP/1.1 200 OK
|
|
Data:Wed,02 May 2018 10:10:01 GMT
|
|
Server: example-server
|
|
Content-Type: application/json {
|
|
"id": 0,
|
|
"state": "NEW",
|
|
"error_code": 0,
|
|
"error_description": "string",
|
|
"total_progress": 0,
|
|
"res_obj": {
|
|
"key_property": [
|
|
{
|
|
"name": "string",
|
|
"value": {},
|
|
"type": "TEXT"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="mrs_02_1097__en-us_topic_0125376218_ul2463624141119"><li id="mrs_02_1097__en-us_topic_0125376218_li780623041116">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1097__en-us_topic_0125376218_table080914831515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_1097__en-us_topic_0125376218_row16990164820154"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.5.1.1.2.5.1.1"><p id="mrs_02_1097__en-us_topic_0125376218_p9990104813151"><strong id="mrs_02_1097__b1437736409">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.5.1.1.2.5.1.2"><p id="mrs_02_1097__en-us_topic_0125376218_p5990154810159">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.5.1.1.2.5.1.3"><p id="mrs_02_1097__en-us_topic_0125376218_p14990104816150"><strong id="mrs_02_1097__b172860670251513">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.39393939393939%" id="mcps1.3.5.1.1.2.5.1.4"><p id="mrs_02_1097__en-us_topic_0125376218_p14990184841510"><strong id="mrs_02_1097__b842352706134712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1097__en-us_topic_0125376218_row89901048141515"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p4990164891515">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p59901148141513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p6990048171511">LONG</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p109901748181518">Asynchronous task ID (meaningless in other scenarios). The default value is <strong id="mrs_02_1097__b842352706191850">-1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row20992184810159"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p599218481159">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p69921948161512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p1899254881516">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p19992548191515">Cluster status. The value <strong id="mrs_02_1097__b842352706191926">FAILED</strong> indicates that the command fails to be executed. The value <strong id="mrs_02_1097__b842352706191940">COMPLETE</strong> indicates that the command is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row1399274871510"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p1799214812151">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p6992048151514">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p1299274812153">INTEGER</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p1599244817151">Error code returned</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row1999219482159"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p18992134891515">error_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p1599224820152">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p1199217485150">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p209927489157">Error code description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row15992174861515"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p1399216480154">total_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p17992848121518">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p899284811154">FLOAT</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p8992124815159">Total progress</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row999284814154"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p099284819153">res_obj</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p59921048161514">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.5.1.1.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p1899217481159">REFERENCE</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.1.1.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p149921248181515">Response object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1097__en-us_topic_0125376218_table1921172819173" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="mrs_02_1097__b842352706193831">res_obj</strong> parameter description</caption><thead align="left"><tr id="mrs_02_1097__en-us_topic_0125376218_row3211528121717"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.1.2.2.5.1.1"><p id="mrs_02_1097__en-us_topic_0125376218_p18166543141714"><strong id="mrs_02_1097__b1080952645">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.1.2.2.5.1.2"><p id="mrs_02_1097__en-us_topic_0125376218_p19170154316177">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.1.2.2.5.1.3"><p id="mrs_02_1097__en-us_topic_0125376218_p617318434174"><strong id="mrs_02_1097__b97880398851513">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.1.2.2.5.1.4"><p id="mrs_02_1097__en-us_topic_0125376218_p121771143131717"><strong id="mrs_02_1097__b877676693">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1097__en-us_topic_0125376218_row1622528201716"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p1163114151813">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p4635341186">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p9638846185">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p12641124141816">Property name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row1722142831712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p101472103186">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p11151161061817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p0157910181815"><T></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p6161151041816">Property value</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1097__en-us_topic_0125376218_row192282861716"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p9164111014182">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p1716751081817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.3 "><p id="mrs_02_1097__en-us_topic_0125376218_p11171410141819">ENUM</p>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_p1517251016180"><Enumeration></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.1.2.2.5.1.4 "><p id="mrs_02_1097__en-us_topic_0125376218_p617691041817">Property type</p>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_p0177141081818">Possible values are:</p>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_p18178210171810"><strong id="mrs_02_1097__b84235270695144">STATUS</strong></p>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_p918011010186"><strong id="mrs_02_1097__b84235270695147">TEXT</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<div class="section" id="mrs_02_1097__en-us_topic_0125376218_section2092982712508"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1097__en-us_topic_0125376218_table2979011121511" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1097__en-us_topic_0125376218_row3981161161515"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.6.2.1.3.1.1"><p id="mrs_02_1097__en-us_topic_0125376218_p398115116158">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="83%" id="mcps1.3.6.2.1.3.1.2"><p id="mrs_02_1097__en-us_topic_0125376218_p1798121191515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1097__en-us_topic_0125376218_row69813112155"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.2.1.3.1.1 "><p id="mrs_02_1097__en-us_topic_0125376218_p15667142018546">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83%" headers="mcps1.3.6.2.1.3.1.2 "><p id="mrs_02_1097__en-us_topic_0125376218_p23378286542">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_1097__en-us_topic_0125376218_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>
|
|
|