forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
161 lines
14 KiB
HTML
161 lines
14 KiB
HTML
<a name="dcs-api-0312018"></a><a name="dcs-api-0312018"></a>
|
|
|
|
<h1 class="topictitle1">Restarting DCS Instances or Clearing DCS Instance Data</h1>
|
|
<div id="body56906561"><div class="section" id="dcs-api-0312018__en-us_topic_0166889632_section7884115112419"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312018__en-us_topic_0166889632_p134956551246">This API is used to restart a running DCS instance.</p>
|
|
<p id="dcs-api-0312018__en-us_topic_0166889632_p106051529867">Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312018__en-us_topic_0166889632_section135003281596"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312018__en-us_topic_0166889632_p124711513684">PUT /v1.0/{project_id}/instances/status</p>
|
|
<div class="p" id="dcs-api-0312018__en-us_topic_0166889632_p73109422372"><a href="#dcs-api-0312018__en-us_topic_0166889632_table344154216371">Table 1</a> describes the parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312018__en-us_topic_0166889632_table344154216371"></a><a name="en-us_topic_0166889632_table344154216371"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312018__en-us_topic_0166889632_table344154216371" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312018__en-us_topic_0166889632_row44454293719"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312018__en-us_topic_0166889632_p143542153710">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312018__en-us_topic_0166889632_p243942133712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312018__en-us_topic_0166889632_p15431742143710">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312018__en-us_topic_0166889632_p1843204253716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312018__en-us_topic_0166889632_row54444263714"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p1144042133712">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p15449424377">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p4441242153712">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312018__en-us_topic_0166889632_p14441242143712">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312018__en-us_topic_0166889632_section8844175611106"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="dcs-api-0312018__en-us_topic_0166889632_p215474220378"><strong id="dcs-api-0312018__en-us_topic_0166889632_b66511756171711">Request parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312018__en-us_topic_0166889632_p956714518379"><a href="#dcs-api-0312018__en-us_topic_0166889632_table103786452372">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312018__en-us_topic_0166889632_table103786452372"></a><a name="en-us_topic_0166889632_table103786452372"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312018__en-us_topic_0166889632_table103786452372" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312018__en-us_topic_0166889632_row1377114516376"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312018__en-us_topic_0166889632_p537711457375">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312018__en-us_topic_0166889632_p1737754583715">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312018__en-us_topic_0166889632_p5377345123713">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312018__en-us_topic_0166889632_p43771145143711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312018__en-us_topic_0166889632_row1437724511376"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p183771145173718">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p537712456375">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p17377124563715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312018__en-us_topic_0166889632_p123771645123710">Action performed on DCS instances. Options: <strong id="dcs-api-0312018__en-us_topic_0166889632_b3512123013817">restart</strong>, and <strong id="dcs-api-0312018__en-us_topic_0166889632_b8361182810814">flush</strong>.</p>
|
|
<div class="note" id="dcs-api-0312018__en-us_topic_0166889632_note1676574710585"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dcs-api-0312018__en-us_topic_0166889632_p976516477581">Only DCS Redis 4.0 and 5.0 instances can be flushed.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312018__en-us_topic_0166889632_row03781645173719"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p11377945183718">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p103774453372">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p163771745133715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312018__en-us_topic_0166889632_p93774453376">List of DCS instance IDs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312018__en-us_topic_0166889632_p12630748153715"><strong id="dcs-api-0312018__en-us_topic_0166889632_b198881650111512">Example request</strong></p>
|
|
<ul id="dcs-api-0312018__en-us_topic_0166889632_ul1754953612219"><li id="dcs-api-0312018__en-us_topic_0166889632_li105491336122220">Request URL:<pre class="screen" id="dcs-api-0312018__en-us_topic_0166889632_screen1429810117101">PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status</pre>
|
|
</li></ul>
|
|
<ul id="dcs-api-0312018__en-us_topic_0166889632_ul111907395228"><li id="dcs-api-0312018__en-us_topic_0166889632_li11190183992213">Example:<pre class="screen" id="dcs-api-0312018__en-us_topic_0166889632_screen2016565018429">{
|
|
"action": "restart",
|
|
"instances": [
|
|
"2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312018__en-us_topic_0166889632_section1526810536111"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312018__en-us_topic_0166889632_p2869205819387"><strong id="dcs-api-0312018__en-us_topic_0166889632_b156412473175">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312018__en-us_topic_0166889632_p1079114143817"><a href="#dcs-api-0312018__en-us_topic_0166889632_table52851943388">Table 3</a> describes the response parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312018__en-us_topic_0166889632_table52851943388"></a><a name="en-us_topic_0166889632_table52851943388"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312018__en-us_topic_0166889632_table52851943388" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312018__en-us_topic_0166889632_row172851641381"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312018__en-us_topic_0166889632_p92851944388">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312018__en-us_topic_0166889632_p628534163813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312018__en-us_topic_0166889632_p228511417382">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312018__en-us_topic_0166889632_row1828514413815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p6285184153819">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p5285154123811">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p15285644384">Indicates the result of instance modification.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312018__en-us_topic_0166889632_table2070112173318" frame="border" border="1" rules="all"><caption><b>Table 4 </b>results parameter description</caption><thead align="left"><tr id="dcs-api-0312018__en-us_topic_0166889632_row4701171710315"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312018__en-us_topic_0166889632_p107011517838">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312018__en-us_topic_0166889632_p47012172037">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312018__en-us_topic_0166889632_p16702817236">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312018__en-us_topic_0166889632_row127025171316"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p15702101711317">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p157020171730">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p1070213176311">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312018__en-us_topic_0166889632_row1702617833"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p10702417734">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p1170214171930">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312018__en-us_topic_0166889632_p1770221712311">Instance modification result. Options: <strong id="dcs-api-0312018__en-us_topic_0166889632_b18540144242919">success</strong> or <strong id="dcs-api-0312018__en-us_topic_0166889632_b455518428294">failed</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312018__en-us_topic_0166889632_p11791452398"><strong id="dcs-api-0312018__en-us_topic_0166889632_b250302011330">Example response</strong><pre class="screen" id="dcs-api-0312018__en-us_topic_0166889632_screen58991123397">{
|
|
"results": [
|
|
{
|
|
"result": "success",
|
|
"instance": "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312018__en-us_topic_0166889632_section1257075711211"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312018__en-us_topic_0166889632_p55711579124"><a href="#dcs-api-0312018__en-us_topic_0166889632_table1357115714126">Table 5</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312018__en-us_topic_0166889632_table1357115714126"></a><a name="en-us_topic_0166889632_table1357115714126"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312018__en-us_topic_0166889632_table1357115714126" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312018__en-us_topic_0166889632_row3571145711215"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312018__en-us_topic_0166889632_p17572125771218">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312018__en-us_topic_0166889632_p1572185781216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312018__en-us_topic_0166889632_row155722572121"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312018__en-us_topic_0166889632_p1757265761210">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312018__en-us_topic_0166889632_p3572185791214">Successfully restarted DCS instance or cleared DCS instance data.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312035.html">Instance Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|