doc-exports/docs/ecs/api-ref/en-us_topic_0020212652.html
Artem Goncharov 3196b64bfc
move doc sources to other location (#3)
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

103 lines
8.2 KiB
HTML

<a name="EN-US_TOPIC_0020212652"></a><a name="EN-US_TOPIC_0020212652"></a>
<h1 class="topictitle1">Stopping an <span id="text899310188453">ECS</span></h1>
<div id="body21982073"><div class="section" id="EN-US_TOPIC_0020212652__section32841145"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212652__p35717517">This API is used to stop a single <span id="EN-US_TOPIC_0020212652__text1461063335213">ECS</span>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section27134857"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212652__p663817276212">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0020212652__p9363238162816">POST /v2/{project_id}/servers/{server_id}/action</p>
<div class="p" id="EN-US_TOPIC_0020212652__p1199962714415"><a href="#EN-US_TOPIC_0020212652__table52155720">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212652__table52155720"></a><a name="table52155720"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212652__table52155720" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212652__row49639248"><th align="left" class="cellrowborder" valign="top" width="16.61%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0020212652__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0020212652__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.22%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0020212652__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212652__row45123001"><td class="cellrowborder" valign="top" width="16.61%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212652__p31084503">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212652__p34816825">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.22%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212652__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212652__row14315403"><td class="cellrowborder" valign="top" width="16.61%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212652__p18697032">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212652__p38064613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="66.22%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212652__p63334794">Specifies the <span id="EN-US_TOPIC_0020212652__text694164210526">ECS</span> ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section42887128"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0020212652__p204351558174110"><a href="#EN-US_TOPIC_0020212652__table54550461">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212652__table54550461"></a><a name="table54550461"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212652__table54550461" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212652__row11842506"><th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0020212652__p19718930">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.299999999999997%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0020212652__p53729511">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_0020212652__p57123120">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.43%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0020212652__p63570006">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212652__row48896832"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020212652__p1220438">os-stop</p>
</td>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020212652__p31746690">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_0020212652__p21345065">Object</p>
</td>
<td class="cellrowborder" valign="top" width="49.43%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020212652__p58405349">Specifies the operation to stop the <span id="EN-US_TOPIC_0020212652__text1137192154510">ECS</span>. For details, see <a href="#EN-US_TOPIC_0020212652__table10346346162744">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212652__table10346346162744"></a><a name="table10346346162744"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212652__table10346346162744" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0020212652__b84235270620940">os-stop</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212652__row45993853162744"><th align="left" class="cellrowborder" valign="top" width="17.1%" id="mcps1.3.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0020212652__p5888173944215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.299999999999997%" id="mcps1.3.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0020212652__p1588833954215">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0020212652__p16888143911424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.44%" id="mcps1.3.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0020212652__p10888639134216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212652__row41908639162744"><td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0020212652__p39156593162744">type</p>
</td>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0020212652__p17567451162744">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0020212652__p13677446162744">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.44%" headers="mcps1.3.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0020212652__p34131354162744">Specifies an ECS stop type. The default value is <strong id="EN-US_TOPIC_0020212652__b84235270612825">SOFT</strong>.</p>
<ul id="EN-US_TOPIC_0020212652__ul1169415154044"><li id="EN-US_TOPIC_0020212652__li14099013154044"><strong id="EN-US_TOPIC_0020212652__b504423009171038">SOFT</strong>: normal ECS stop</li><li id="EN-US_TOPIC_0020212652__li59782258154044"><strong id="EN-US_TOPIC_0020212652__b8423527061788">HARD</strong>: forcible ECS stop</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section50439840"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0020212652__p33212803">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section38609473427"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0020212652__screen63704316220">POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action</pre>
<pre class="screen" id="EN-US_TOPIC_0020212652__screen64712762194611">{
"os-stop": {}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section108329486315"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0020212652__p162168581130">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212652__section51305376"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212652__p5882489">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0124385016.html">Status Management</a></div>
</div>
</div>