forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
141 lines
11 KiB
HTML
141 lines
11 KiB
HTML
<a name="EN-US_TOPIC_0020212649"></a><a name="EN-US_TOPIC_0020212649"></a>
|
|
|
|
<h1 class="topictitle1">Restarting <span id="text264719253267">ECS</span>s in a Batch</h1>
|
|
<div id="body2701015"><div class="section" id="EN-US_TOPIC_0020212649__section39601516"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212649__p17455632">This API is used to restart <span id="EN-US_TOPIC_0020212649__text18806126182610">ECS</span>s in a batch based on specified <span id="EN-US_TOPIC_0020212649__text1130623615126">ECS</span> IDs. A maximum of 1000 <span id="EN-US_TOPIC_0020212649__text18468143916128">ECS</span>s can be restarted at a time.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section20869327"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212649__p55283621154452">POST /v1/{project_id}/cloudservers/action</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212649__p187987782310"><a href="#EN-US_TOPIC_0020212649__table33008913">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212649__table33008913"></a><a name="table33008913"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212649__table33008913" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212649__row32701678"><th align="left" class="cellrowborder" valign="top" width="16.42%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0020212649__p31590262">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.36%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0020212649__p8674443">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66.22%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0020212649__p31541268">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212649__row4705914"><td class="cellrowborder" valign="top" width="16.42%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212649__p45634724">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212649__p5425146">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.22%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212649__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section53606218"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0020212649__p380313150244"><a href="#EN-US_TOPIC_0020212649__table54749715">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212649__table54749715"></a><a name="table54749715"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212649__table54749715" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212649__row24121565"><th align="left" class="cellrowborder" valign="top" width="16.35%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0020212649__p7689721">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0020212649__p18887690">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0020212649__p53507960">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0020212649__p39177514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212649__row19262089"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020212649__p16725372">reboot</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020212649__p12577900">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020212649__p12176960">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020212649__p18634089">Specifies the operation to restart the <span id="EN-US_TOPIC_0020212649__text4589329112610">ECS</span>. For details, see <a href="#EN-US_TOPIC_0020212649__table64591731162222">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212649__table64591731162222"></a><a name="table64591731162222"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212649__table64591731162222" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong>reboot</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212649__row30453945162222"><th align="left" class="cellrowborder" valign="top" width="16.35%" id="mcps1.3.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0020212649__p26274222513">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0020212649__p4627202192519">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.18%" id="mcps1.3.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0020212649__p66276219259">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0020212649__p364202152512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212649__row42922987162336"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0020212649__p50762568162336">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0020212649__p18127378162336">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.18%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0020212649__p59031541162336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0020212649__p16825496162336">Specifies the type of the restart operation.</p>
|
|
<ul id="EN-US_TOPIC_0020212649__ul62344604154036"><li id="EN-US_TOPIC_0020212649__li24796316154036"><strong>SOFT</strong>: soft restart</li><li id="EN-US_TOPIC_0020212649__li21840259154036"><strong id="EN-US_TOPIC_0020212649__b5811448105018">HARD</strong>: forcible restart (hard restart)</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212649__row10461780162222"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0020212649__p19668200162240">servers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0020212649__p49620364162240">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.18%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0020212649__p59826577162240">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0020212649__p59922456162240">Specifies <span id="EN-US_TOPIC_0020212649__text169711209136">ECS</span> IDs. For details, see <a href="#EN-US_TOPIC_0020212649__table26785545162223">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212649__table26785545162223"></a><a name="table26785545162223"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212649__table26785545162223" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong>servers</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212649__row56759147162223"><th align="left" class="cellrowborder" valign="top" width="16.35%" id="mcps1.3.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0020212649__p1468216622519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0020212649__p11682168253">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.17%" id="mcps1.3.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0020212649__p9682167253">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0020212649__p20682769256">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212649__row205574162223"><td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0020212649__p16651565162223">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0020212649__p6599487162223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0020212649__p64796454162223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0020212649__p59084190162223">Specifies the <span id="EN-US_TOPIC_0020212649__text1526102971311">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section12693918"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0020212649__p26323242">See <a href="en-us_topic_0022067714.html">Responses (Task)</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section366624342413"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0020212649__p587418175535">In the request, the parameters to restart <span id="EN-US_TOPIC_0020212649__text18501143218267">ECS</span>s must be sent with field <strong id="EN-US_TOPIC_0020212649__b6509388164">reboot</strong>. For details, see the example request.<pre class="screen" id="EN-US_TOPIC_0020212649__screen1094117493114">POST https://{endpoint}/v1/{project_id}/cloudservers/action</pre>
|
|
<pre class="screen" id="EN-US_TOPIC_0020212649__screen16134303194410">{
|
|
"reboot": {
|
|
"type":"SOFT",
|
|
"servers": [
|
|
{
|
|
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
|
|
},
|
|
{
|
|
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
|
|
}
|
|
|
|
]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section18237102335311"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0020212649__p1541522718537">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section27037160"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212649__p23224207">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212649__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020212649__p7233105282813">See <a href="en-us_topic_0022067717.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0167816247.html">Batch Operations</a></div>
|
|
</div>
|
|
</div>
|
|
|