yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0b3a43371a4bcc99577594de0a685249d676a567
doc-exports/docs/dcs/api-ref/RestartOrFlushInstances.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

237 lines
18 KiB
HTML
Raw Blame History

<a name="RestartOrFlushInstances"></a><a name="RestartOrFlushInstances"></a>
<h1 class="topictitle1">Restarting DCS Instances or Clearing DCS Instance Data</h1>
<div id="body1708331107508"><div class="section" id="RestartOrFlushInstances__section1333471216326"><h4 class="sectiontitle">Function</h4><p id="RestartOrFlushInstances__p15334171273210">This API is used to restart a running DCS instance.</p>
<p id="RestartOrFlushInstances__p7334612103213">This API can also be used to clear data of DCS Redis 4.0 and later instances. Cleared data cannot be restored. Exercise caution.</p>
</div>
<div class="section" id="RestartOrFlushInstances__section173341612183213"><h4 class="sectiontitle">URI</h4><p id="RestartOrFlushInstances__p17334151233216">PUT /v2/{project_id}/instances/status</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__table103341212123213" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="RestartOrFlushInstances__row33348124328"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="RestartOrFlushInstances__p16335161213218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="RestartOrFlushInstances__p53358121323">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="RestartOrFlushInstances__p3335191283216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="RestartOrFlushInstances__p1633514122321">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row1633412125321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="RestartOrFlushInstances__p1335141273218">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="RestartOrFlushInstances__p53351512113217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="RestartOrFlushInstances__p2033521223216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="RestartOrFlushInstances__p7335112103213">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="RestartOrFlushInstances__section18335912163219"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__request_ChangeInstanceStatusBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="RestartOrFlushInstances__row2335141213214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="RestartOrFlushInstances__p133691263212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="RestartOrFlushInstances__p23361312173216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="RestartOrFlushInstances__p1033671213324">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="RestartOrFlushInstances__p14337111233220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row1335171217320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="RestartOrFlushInstances__p9337101216321">instances</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="RestartOrFlushInstances__p103371312103220">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="RestartOrFlushInstances__p03378122325">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="RestartOrFlushInstances__p93371112123218">List of instance IDs.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row8335131219321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="RestartOrFlushInstances__p9337121211328">action</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="RestartOrFlushInstances__p8337151214325">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="RestartOrFlushInstances__p18337512193216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="RestartOrFlushInstances__p19338412123219">Operation on the instance:</p>
<p id="RestartOrFlushInstances__p1633814125324"><strong id="RestartOrFlushInstances__b03387124323">restart</strong>: force restart</p>
<p id="RestartOrFlushInstances__p8338912103214"><strong id="RestartOrFlushInstances__b13338312113210">soft_restart</strong>: restart only the instance process</p>
<p id="RestartOrFlushInstances__p1833811127325"><strong id="RestartOrFlushInstances__b1933813122322">flush</strong>: clear data</p>
<div class="note" id="RestartOrFlushInstances__note533861210328"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="RestartOrFlushInstances__p16338412133215">Only DCS Redis 4.0 and later instances can be flushed.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="RestartOrFlushInstances__section733851293216"><h4 class="sectiontitle">Response Parameters</h4><p id="RestartOrFlushInstances__p1833811223213"><strong id="RestartOrFlushInstances__b1233881219325">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__response_BatchOpsResultsResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="RestartOrFlushInstances__row1633901215323"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="RestartOrFlushInstances__p833921216322">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="RestartOrFlushInstances__p9339131216324">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="RestartOrFlushInstances__p11339141233213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row17339171215325"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="RestartOrFlushInstances__p1833961293216">results</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="RestartOrFlushInstances__p20339171211322">Array of <a href="#RestartOrFlushInstances__response_BatchOpsResult">BatchOpsResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="RestartOrFlushInstances__p1533971214324">Result of deleting, restarting, or clearing data of an instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="RestartOrFlushInstances__response_BatchOpsResult"></a><a name="response_BatchOpsResult"></a><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__response_BatchOpsResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>BatchOpsResult</caption><thead align="left"><tr id="RestartOrFlushInstances__row1339181263215"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="RestartOrFlushInstances__p9340121203213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="RestartOrFlushInstances__p1134041293218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="RestartOrFlushInstances__p17340312153211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row13339712113216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="RestartOrFlushInstances__p14340191220325">result</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="RestartOrFlushInstances__p2340121219326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="RestartOrFlushInstances__p183401512133219">Instance deletion result. Options: <strong id="RestartOrFlushInstances__b133401212203214">success</strong> and <strong id="RestartOrFlushInstances__b1234021213323">failed</strong>.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row1533918129325"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="RestartOrFlushInstances__p3340161263218">instance</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="RestartOrFlushInstances__p5340121243213">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="RestartOrFlushInstances__p16340161243216">DCS instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="RestartOrFlushInstances__p20340151210324"><strong id="RestartOrFlushInstances__b834091213326">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="RestartOrFlushInstances__row234051233217"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="RestartOrFlushInstances__p6341151223214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="RestartOrFlushInstances__p3341111223214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="RestartOrFlushInstances__p5341191213214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row16340101218322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="RestartOrFlushInstances__p7341181223220">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="RestartOrFlushInstances__p534171243214">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="RestartOrFlushInstances__p034141283214">Error message.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row534013123321"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="RestartOrFlushInstances__p934111125324">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="RestartOrFlushInstances__p9341181217322">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="RestartOrFlushInstances__p4341812113215">Error code.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row16340111213219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="RestartOrFlushInstances__p8341141210324">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="RestartOrFlushInstances__p15341212103212">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="RestartOrFlushInstances__p183411212103210">Extended error information. This parameter is not used currently and is set to <strong id="RestartOrFlushInstances__b1634131243216">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="RestartOrFlushInstances__p1234111220327"><strong id="RestartOrFlushInstances__b5341131212324">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__table153411312173214" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="RestartOrFlushInstances__row8341512103215"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="RestartOrFlushInstances__p19342191210328">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="RestartOrFlushInstances__p2034217128324">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="RestartOrFlushInstances__p19342912113218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row1134171213326"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="RestartOrFlushInstances__p1534221233212">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="RestartOrFlushInstances__p17342181283214">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="RestartOrFlushInstances__p734271217326">Error message.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row133415121327"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="RestartOrFlushInstances__p33421812153213">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="RestartOrFlushInstances__p1534281215326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="RestartOrFlushInstances__p11342181210321">Error code.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row6341201210321"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="RestartOrFlushInstances__p103421612183216">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="RestartOrFlushInstances__p1334241243213">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="RestartOrFlushInstances__p9342131213322">Extended error information. This parameter is not used currently and is set to <strong id="RestartOrFlushInstances__b15342181216323">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="RestartOrFlushInstances__section18342612173218"><h4 class="sectiontitle">Example Requests</h4><p id="RestartOrFlushInstances__p19342312193213">Force restarting a DCS instance</p>
<pre class="screen" id="RestartOrFlushInstances__screen53430123324">PUT https://{dcs_endpoint}/v2/{project_id}/instances/status
{
"instances" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ],
"action" : "restart"
}</pre>
</div>
<div class="section" id="RestartOrFlushInstances__section11343151210326"><h4 class="sectiontitle">Example Responses</h4><p id="RestartOrFlushInstances__p23431412153217"><strong id="RestartOrFlushInstances__b9343141219325">Status code: 200</strong></p>
<p id="RestartOrFlushInstances__p2343912113211">DCS instances restarted successfully or the instance data cleared successfully.</p>
<pre class="screen" id="RestartOrFlushInstances__screen1234341215323">{
"results" : [ {
"instance" : "e3a7019c-8824-4c1a-8289-5300f19b9f64",
"result" : "success"
} ]
}</pre>
</div>
<div class="section" id="RestartOrFlushInstances__section173431612183213"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartOrFlushInstances__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="RestartOrFlushInstances__row234351211329"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="RestartOrFlushInstances__p5344112203215">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="RestartOrFlushInstances__p834451223213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="RestartOrFlushInstances__row4343181263219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="RestartOrFlushInstances__p2344101218325">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="RestartOrFlushInstances__p143448124322">DCS instances restarted successfully or the instance data cleared successfully.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row12344912133216"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="RestartOrFlushInstances__p1934417121322">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="RestartOrFlushInstances__p203444123321">Invalid request.</p>
</td>
</tr>
<tr id="RestartOrFlushInstances__row4344612153212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="RestartOrFlushInstances__p83441112143215">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="RestartOrFlushInstances__p193447120323">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="RestartOrFlushInstances__section4344191213328"><h4 class="sectiontitle">Error Codes</h4><p id="RestartOrFlushInstances__p1234451233215">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="InstanceManagement.html">Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink