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>
166 lines
14 KiB
HTML
166 lines
14 KiB
HTML
<a name="mrs_02_1095"></a><a name="mrs_02_1095"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a Service</h1>
|
|
<div id="body8662426"><div class="section" id="mrs_02_1095__en-us_topic_0125376207_section1772474704712"><h4 class="sectiontitle">Function </h4><p class="MsoNormal" id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p49554324">This API is used to stop a specified service.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_1095__en-us_topic_0125376207_sb9bf8e16ff894d989c1ce75073e203ab"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_1095__en-us_topic_0125376207_ul20902151774815"><li id="mrs_02_1095__en-us_topic_0125376207_li4902191712489">Format</li></ul>
|
|
<p class="MsoNormal" id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p11054069">POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/stop</p>
|
|
<ul id="mrs_02_1095__en-us_topic_0125376207_ul12765143118481"><li class="TableDescription" id="mrs_02_1095__en-us_topic_0125376207_li1476553134814">URI parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_table22964363" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row31097035"><th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.2.5.1.4.1.1"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p35831867"><strong id="mrs_02_1095__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_1095__en-us_topic_0125376207_en-us_topic_0110839919_p16700087">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_1095__en-us_topic_0125376207_en-us_topic_0110839919_p45230279"><strong id="mrs_02_1095__b842352706134712">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row39773978"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p466794">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_1095__en-us_topic_0125376207_en-us_topic_0110839919_p37810334">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p41806332">Name of the service to be stopped</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row40712668"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p9391796">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_1095__en-us_topic_0125376207_en-us_topic_0110839919_p22537988">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p36147099">Cluster ID that is displayed on MRS Manager. The default cluster ID is <strong id="mrs_02_1095__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_1095__en-us_topic_0125376207_s8a44ad9620a7423ab7add53ac804f9bf"><h4 class="sectiontitle">Request</h4><ul id="mrs_02_1095__en-us_topic_0125376207_ul62901616145114"><li id="mrs_02_1095__en-us_topic_0125376207_li16290151635110">Example:<pre class="screen" id="mrs_02_1095__en-us_topic_0125376207_screen1546424145115">POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/stop HTTP/1.1
|
|
Host: example.com
|
|
Content-Type: application/json
|
|
Accept:application/json
|
|
{
|
|
"user_password": "string",
|
|
"only_self": true
|
|
}</pre>
|
|
</li><li class="TableDescription" id="mrs_02_1095__en-us_topic_0125376207_li16723153519519">Request parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_table52586183" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameter description</caption><thead align="left"><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row61378506"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.3.2.5.1.1"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p5603129"><strong id="mrs_02_1095__b59050740">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.3.2.5.1.2"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p51200337">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.3.2.5.1.3"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p53586617"><strong id="mrs_02_1095__b213868865914512">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.3.3.2.5.1.4"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p9233635"><strong id="mrs_02_1095__b946628058">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row9727005"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p49689968">user_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.3.2.5.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p65464451">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p1020286">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.3.2.5.1.4 "><p id="mrs_02_1095__en-us_topic_0125376207_p421610270133">Password of the login user. This parameter is used for secondary authentication. If you call REST APIs, secondary authentication is not required and you do not need to set this parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row43670673"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.3.2.5.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p47663658">only_self</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.3.2.5.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p35551095">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.5.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p61066465">BOOLEAN</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.3.2.5.1.4 "><p id="mrs_02_1095__en-us_topic_0125376207_p1474655510588">Whether to operate only the specified service</p>
|
|
<p id="mrs_02_1095__en-us_topic_0125376207_p17465557584"><strong id="mrs_02_1095__b842352706204759">false</strong>: The services depending on the service are also stopped.</p>
|
|
<p id="mrs_02_1095__en-us_topic_0125376207_p27461755165812"><strong id="mrs_02_1095__b842352706204833">true</strong>: Only the specified service is stopped.</p>
|
|
<p id="mrs_02_1095__en-us_topic_0125376207_p17466554586">If you call REST APIs, secondary authentication is not required and you do not need to set this parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_1095__en-us_topic_0125376207_s88d2bea3977f4f49bdbed2e0102dce7f"><h4 class="sectiontitle">Response</h4><ul id="mrs_02_1095__en-us_topic_0125376207_ul7199355185411"><li id="mrs_02_1095__en-us_topic_0125376207_li31991155155415">Example:<pre class="screen" id="mrs_02_1095__en-us_topic_0125376207_screen2537154265518">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
|
|
}</pre>
|
|
</li><li class="TableDescription" id="mrs_02_1095__en-us_topic_0125376207_li752819135612">Response parameter description</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_table47159308" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row24324526"><th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.4.3.1.4.1.1"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p24129567"><strong id="mrs_02_1095__b415522141">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.4.3.1.4.1.2"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p8337942">Mandatory or Not</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.08%" id="mcps1.3.4.3.1.4.1.3"><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p42731707"><strong id="mrs_02_1095__b1712303595">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row38716256"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p49009017">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p10307439">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.4.3.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p61915010">Asynchronous task ID (meaningless in other scenarios). The default value is <strong id="mrs_02_1095__b842352706191850">-1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row20364184"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p38886230">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p62776900">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.4.3.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_p16759122410200">Cluster status</p>
|
|
<ul id="mrs_02_1095__en-us_topic_0125376207_ul137411037122018"><li id="mrs_02_1095__en-us_topic_0125376207_li18741123716201"><strong id="mrs_02_1095__b72361517122">FAILED</strong>: The command failed to be executed. </li><li id="mrs_02_1095__en-us_topic_0125376207_li1526744082017"><strong id="mrs_02_1095__b129911155128">COMPLETE</strong>: The command is executed successfully.</li><li id="mrs_02_1095__en-us_topic_0125376207_li184631743172011">IN_PROGRESS: The command is being executed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row38817391"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p57201005">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p2769839">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.4.3.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p366853">Error code returned</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row3301680"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p66109542">error_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p53272692">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.4.3.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p44975555">Error code description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_row2126816"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p38054408">total_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.1.4.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p62508221">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.4.3.1.4.1.3 "><p id="mrs_02_1095__en-us_topic_0125376207_en-us_topic_0110839919_p37634732">Total progress</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_1095__en-us_topic_0125376207_section2092982712508"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1095__en-us_topic_0125376207_table2979011121511" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1095__en-us_topic_0125376207_row3981161161515"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.2.1.3.1.1"><p id="mrs_02_1095__en-us_topic_0125376207_p398115116158">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="83%" id="mcps1.3.5.2.1.3.1.2"><p id="mrs_02_1095__en-us_topic_0125376207_p1798121191515">Description </p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_1095__en-us_topic_0125376207_row69813112155"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.1.1 "><p id="mrs_02_1095__en-us_topic_0125376207_p15667142018546">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="83%" headers="mcps1.3.5.2.1.3.1.2 "><p id="mrs_02_1095__en-us_topic_0125376207_p23378286542">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_1095__en-us_topic_0125376207_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>
|
|
|