doc-exports/docs/mrs/api-ref/mrs_02_1091.html
Yang, Tong bd2b57f749 MRS API 2.0.38.SP20 version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2022-11-16 15:06:08 +00:00

272 lines
24 KiB
HTML

<a name="mrs_02_1091"></a><a name="mrs_02_1091"></a>
<h1 class="topictitle1">Querying the Command Execution Progress</h1>
<div id="body8662426"><div class="section" id="mrs_02_1091__en-us_topic_0125376258_section132313464914"><h4 class="sectiontitle">Function </h4><p class="MsoNormal" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p36312246">This API is used to query the command execution progress by command ID, including the total progress and the detailed progress of each step.</p>
</div>
<div class="section" id="mrs_02_1091__en-us_topic_0125376258_sd919b2e337864622b820bd95e2c3c1c1"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_1091__en-us_topic_0125376258_ul6452122383312"><li id="mrs_02_1091__en-us_topic_0125376258_li345282313338">Format</li></ul>
<p class="MsoNormal" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p20644201">GET /web/v1/common/command/{command_id}/progress</p>
<ul id="mrs_02_1091__en-us_topic_0125376258_ul1877924333319"><li class="TableDescription" id="mrs_02_1091__en-us_topic_0125376258_li1779134313310">URI parameter description</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_table61567624" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row43465205"><th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.2.5.1.4.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p31020730"><strong id="mrs_02_1091__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_1091__en-us_topic_0125376258_en-us_topic_0110839915_p29651187">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_1091__en-us_topic_0125376258_en-us_topic_0110839915_p27389957"><strong id="mrs_02_1091__b842352706134712">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row3994012"><td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p55079576">command_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.2.5.1.4.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p32260705">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.08%" headers="mcps1.3.2.5.1.4.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_p38163105386">Command ID, which can be obtained from the response of the asynchronous request</p>
<p id="mrs_02_1091__en-us_topic_0125376258_p14816710113815">Asynchronous requests include requests for saving configurations and starting and stopping services.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_1091__en-us_topic_0125376258_sd64edd6241824b7cb64f9a14b940004c"><h4 class="sectiontitle">Request</h4><ul id="mrs_02_1091__en-us_topic_0125376258_ul15876104616342"><li class="MsoNormal" id="mrs_02_1091__en-us_topic_0125376258_li128761146153410">Example:<pre class="screen" id="mrs_02_1091__en-us_topic_0125376258_screen1456311125425">GET /web/v1/common/command/{command_id}/progress HTTP/1.1
Host: example.com
Content-Type: application/json
Accept:application/json</pre>
</li><li id="mrs_02_1091__en-us_topic_0125376258_li13248846204312">Parameter description<p id="mrs_02_1091__en-us_topic_0125376258_p17235255194313"><a name="mrs_02_1091__en-us_topic_0125376258_li13248846204312"></a><a name="en-us_topic_0125376258_li13248846204312"></a>None</p>
</li></ul>
</div>
<div class="section" id="mrs_02_1091__en-us_topic_0125376258_s318b876a953c4974ad48f83be32b094c"><h4 class="sectiontitle">Response</h4><ul id="mrs_02_1091__en-us_topic_0125376258_ul58021658440"><li id="mrs_02_1091__en-us_topic_0125376258_li8802859443">Example:<pre class="screen" id="mrs_02_1091__en-us_topic_0125376258_screen108101239134416">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": {
"cluster_id": 0,
"step_list": [
{
"name": "string",
"description": "string"
}
],
"fail_entity_list": [
{
"fail_entity": "string",
"operation_type": "string"
}
],
"total_step_size": 0
}
}</pre>
</li><li id="mrs_02_1091__en-us_topic_0125376258_li65855479441">Parameter description</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_table42073913" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row46197435"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.2.5.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p51004735"><strong id="mrs_02_1091__b76403123">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.2.5.1.2"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p37742864">Mandatory or Not</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.3.2.5.1.3"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p37273109"><strong id="mrs_02_1091__b1237484425163">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.4.3.2.5.1.4"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p2159343"><strong id="mrs_02_1091__b869833057">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row40689110"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p7483642">id</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p2195266">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p43598871">LONG</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p20058992">Asynchronous task ID (meaningless in other scenarios). The default value is <strong id="mrs_02_1091__b842352706191850">-1</strong>.</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row46313202"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p60381886">state</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p59094594">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p21932839">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p42197016">Cluster status. The value <strong id="mrs_02_1091__b842352706191926">FAILED</strong> indicates that the command fails to be executed. The value <strong id="mrs_02_1091__b842352706191940">COMPLETE</strong> indicates that the command is successfully executed.</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row44228825"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p25765033">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p6592901">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p64262998">INTEGER</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p23110933">Error code returned</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row6671808"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p3545613">error_description</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p18759226">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p43102319">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p4211794">Error code description</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row37906154"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p50499596">total_progress</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p63935491">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p11392311">FLOAT</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p48142285">Total progress</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row30627385"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p64899100">res_obj</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p22335719">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.3.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p64362819">REFERENCE</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.3.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p50939954">Response object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_table32495643" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="mrs_02_1091__b842352706193831">res_obj</strong> parameter description</caption><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row54638644"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.4.2.5.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p63654061"><strong id="mrs_02_1091__b2011537970">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.4.2.5.1.2"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p55705286">Mandatory or Not</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.4.2.5.1.3"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p15834279"><strong id="mrs_02_1091__b16041274695163">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.4.4.2.5.1.4"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p3507726"><strong id="mrs_02_1091__b1903499547">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row15690402"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p62963013">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p66839330">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p45276639">INTEGER</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.4.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p46370664">Cluster ID </p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row14682800"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p48456183">step_list</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p32636713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p26328112">ARRAY_REFERENCE</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.4.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p4792001">Records the progress of each step in an array. A command may be divided into multiple steps for execution.</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row43128017"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p3708474">fail_entity_list</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p31950976">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p37892234">ARRAY_REFERENCE</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.4.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p21907564">List of failed operations. Currently, this function is supported for starting, stopping, and restarting the service. Other operations are not supported (an empty array is returned).</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row62950355"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p65814015">total_step_size</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p29335032">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.4.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p27327397">INTEGER</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.4.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p4531576">Total command execution progress. The value ranges from 0 to 100.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_table31513351" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="mrs_02_1091__b1290984923">step_list</strong> parameter description</caption><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row63574456"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.5.2.5.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p49257331"><strong id="mrs_02_1091__b84307495">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.5.2.5.1.2"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p30420887">Mandatory or Not</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.5.2.5.1.3"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p48172746"><strong id="mrs_02_1091__b11329042615163">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.4.5.2.5.1.4"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p14940377"><strong id="mrs_02_1091__b396509099">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row2211039"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p44876477">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p11116060">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p27985700">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.5.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p15003965">Partition name</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row817961"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p66254894">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p65046183">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.5.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p34249469">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.5.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p37592761">Description</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_table25114768" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="mrs_02_1091__b1195299995">fail_entity_list</strong> parameter description</caption><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row43903439"><th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.6.2.5.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p66517662"><strong id="mrs_02_1091__b184722518">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.6.2.5.1.2"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p19221566">Mandatory or Not</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.292029202920293%" id="mcps1.3.4.6.2.5.1.3"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p13443031"><strong id="mrs_02_1091__b15556337295163">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.123912391239124%" id="mcps1.3.4.6.2.5.1.4"><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p36670851"><strong id="mrs_02_1091__b718628304">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row17548941"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p12178136">fail_entity</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p46904972">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p41206351">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.6.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p48824334">Failed instance</p>
</td>
</tr>
<tr id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_row36765828"><td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p25242057">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p31340714">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.292029202920293%" headers="mcps1.3.4.6.2.5.1.3 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p55569937">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="39.123912391239124%" headers="mcps1.3.4.6.2.5.1.4 "><p id="mrs_02_1091__en-us_topic_0125376258_en-us_topic_0110839915_p14888430">Operation type: STOP or START</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_1091__en-us_topic_0125376258_section2092982712508"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_1091__en-us_topic_0125376258_table2979011121511" frame="border" border="1" rules="all"><thead align="left"><tr id="mrs_02_1091__en-us_topic_0125376258_row3981161161515"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.2.1.3.1.1"><p id="mrs_02_1091__en-us_topic_0125376258_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_1091__en-us_topic_0125376258_p1798121191515">Description </p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_1091__en-us_topic_0125376258_row69813112155"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.3.1.1 "><p id="mrs_02_1091__en-us_topic_0125376258_p15667142018546">200</p>
</td>
<td class="cellrowborder" valign="top" width="83%" headers="mcps1.3.5.2.1.3.1.2 "><p id="mrs_02_1091__en-us_topic_0125376258_p23378286542">The operation is successful.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_1091__en-us_topic_0125376258_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>