forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
128 lines
9.7 KiB
HTML
128 lines
9.7 KiB
HTML
<a name="EN-US_TOPIC_0020212207"></a><a name="EN-US_TOPIC_0020212207"></a>
|
|
|
|
<h1 class="topictitle1">Starting <span id="text590801817265">ECS</span>s in a Batch</h1>
|
|
<div id="body20084682"><div class="section" id="EN-US_TOPIC_0020212207__section18389930"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212207__p16246551">This API is used to start <span id="EN-US_TOPIC_0020212207__text184481972617">ECS</span>s in a batch based on specified <span id="EN-US_TOPIC_0020212207__text56551812104">ECS</span> IDs. A maximum of 1000 <span id="EN-US_TOPIC_0020212207__text9234136181017">ECS</span>s can be started at a time.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section31291646"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212207__p40289078154117">POST /v1/{project_id}/cloudservers/action</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212207__p446815165189"><a href="#EN-US_TOPIC_0020212207__table58892473">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212207__table58892473"></a><a name="table58892473"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212207__table58892473" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212207__row45596481"><th align="left" class="cellrowborder" valign="top" width="16.98%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0020212207__p2327487">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.16%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0020212207__p54308798">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.86%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0020212207__p36936550">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212207__row39070558"><td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212207__p10598606">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.16%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212207__p53180767">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.86%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212207__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section13189358"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212207__table66572856" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212207__row53954942"><th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0020212207__p8274172">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0020212207__p66228199">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0020212207__p62883878">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.81%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0020212207__p60429346">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212207__row62938818"><td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0020212207__p64879470">os-start</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0020212207__p20745743">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0020212207__p2683661">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.81%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0020212207__p10232270">Specifies the operation to start the <span id="EN-US_TOPIC_0020212207__text7436192118263">ECS</span>. For details, see <a href="#EN-US_TOPIC_0020212207__table52132698163051">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212207__table52132698163051"></a><a name="table52132698163051"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212207__table52132698163051" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0020212207__b84235270620940">os-start</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212207__row58550307163051"><th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0020212207__p22861271209">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0020212207__p13286132712018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0020212207__p1028616277208">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.81%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0020212207__p16286827182014">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212207__row63441585163051"><td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0020212207__p38494721163051">servers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0020212207__p31064669163051">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0020212207__p33210286163051">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.81%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0020212207__p48899565163125">Specifies <span id="EN-US_TOPIC_0020212207__text422862232617">ECS</span> IDs. For details, see <a href="#EN-US_TOPIC_0020212207__table23507505">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212207__table23507505"></a><a name="table23507505"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212207__table23507505" 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_0020212207__row5109846"><th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0020212207__p477877142215">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0020212207__p1777847162211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0020212207__p077816719225">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.81%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0020212207__p1077816719222">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212207__row66578044"><td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0020212207__p24112512">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0020212207__p6956456">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0020212207__p26602077">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.81%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0020212207__p65561530">Specifies the <span id="EN-US_TOPIC_0020212207__text1122175813100">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section51595365"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0020212207__p12844374">See <a href="en-us_topic_0022067714.html">Responses (Task)</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section1741103616214"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0020212207__p7408329165216">In the request, the parameters to start <span id="EN-US_TOPIC_0020212207__text36852236260">ECS</span>s must be sent with field <strong id="EN-US_TOPIC_0020212207__b15323102912111">os-start</strong>. For details, see the example request.<pre class="screen" id="EN-US_TOPIC_0020212207__screen312418227307">POST https://{endpoint}/v1/{project_id}/cloudservers/action</pre>
|
|
<pre class="screen" id="EN-US_TOPIC_0020212207__screen11949642193750">{
|
|
"os-start": {
|
|
"servers": [
|
|
{
|
|
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
|
|
},
|
|
{
|
|
"id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section1589616484522"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0020212207__p116281453185218">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section17349988"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212207__p23410681">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212207__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020212207__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>
|
|
|