vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0065817688.html
Zaoxu, Li be55bdb9f8 ECS API DOC 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-05-24 13:36:19 +00:00

378 lines
33 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065817688"></a><a name="EN-US_TOPIC_0065817688"></a>
<h1 class="topictitle1">Rebuilding an ECS</h1>
<div id="body1499652824860"><div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section59295179204041"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p28632289204444">This API is used to rebuild an ECS.</p>
<p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p137919495118">You can use the original image or another image to rebuild an ECS. This API supports different OSs.</p>
</div>
<p id="EN-US_TOPIC_0065817688__p10790194961711">This API is native from the community for defcore tests. </p>
<p id="EN-US_TOPIC_0065817688__p19355618174">If you are required to reinstall or change an ECS OS, ECS APIs are recommended. For details, see "Reinstalling an ECS OS (Using an Image with Cloud-Init Installed)" and "Changing an OS (Using an Image with Cloud-Init Installed)".</p>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section7529181132617"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_ul115321115268"><li id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_li175341717266">ECSs in the error state cannot be rebuilt.</li><li id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_li16535412263">The password cannot be set during the rebuilding.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section50411366204518"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p10222132152510">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0065817688__p0505133123014">POST /v2/{project_id}/servers/{server_id}/action</p>
<div class="p" id="EN-US_TOPIC_0065817688__p765019114573"><a href="#EN-US_TOPIC_0065817688__en-us_topic_0058745339_table46110007">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table46110007"></a><a name="en-us_topic_0058745339_table46110007"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table46110007" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row14148614"><th align="left" class="cellrowborder" valign="top" width="20.74%" id="mcps1.3.5.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817688__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.5.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817688__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.27%" id="mcps1.3.5.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817688__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row17201924"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.5.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p51178607">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.5.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p51826478">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.5.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row615338831654"><td class="cellrowborder" valign="top" width="20.74%" headers="mcps1.3.5.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p519996316521">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.5.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5588153816521">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59.27%" headers="mcps1.3.5.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p1719074216521">Specifies the ECS ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section48864997204742"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817688__p191404491571"><a href="#EN-US_TOPIC_0065817688__en-us_topic_0058745339_table44724688204850">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table44724688204850"></a><a name="en-us_topic_0058745339_table44724688204850"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table44724688204850" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row1798761204850"><th align="left" class="cellrowborder" valign="top" width="19.57%" id="mcps1.3.6.3.2.5.1.1"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p39560242204918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.2%" id="mcps1.3.6.3.2.5.1.2"><p id="EN-US_TOPIC_0065817688__p4117282186">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.04%" id="mcps1.3.6.3.2.5.1.3"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p50263001204918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.190000000000005%" id="mcps1.3.6.3.2.5.1.4"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p2596798204918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row5848663204850"><td class="cellrowborder" valign="top" width="19.57%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p22382703204933">rebuild</p>
</td>
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p11111228191811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p1059631204933">Object</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p40030009204933">Rebuilds an ECS. For details, see <a href="#EN-US_TOPIC_0065817688__en-us_topic_0058745339_table59377750205027">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table59377750205027"></a><a name="en-us_topic_0058745339_table59377750205027"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table59377750205027" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_b30580951">rebuild</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row1841518205027"><th align="left" class="cellrowborder" valign="top" width="19.950000000000003%" id="mcps1.3.6.4.2.5.1.1"><p id="EN-US_TOPIC_0065817688__p1568292016586">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.82%" id="mcps1.3.6.4.2.5.1.2"><p id="EN-US_TOPIC_0065817688__p1639583116187">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.04%" id="mcps1.3.6.4.2.5.1.3"><p id="EN-US_TOPIC_0065817688__p146981320145813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.190000000000005%" id="mcps1.3.6.4.2.5.1.4"><p id="EN-US_TOPIC_0065817688__p1869842018581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row20042728205027"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p29571470205128">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p939512315184">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p46478847205128">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p239617401318">Specifies the name of the rebuilt ECS.</p>
<p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5042904205128">The value contains 1 to 254 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row57219807205027"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p52398862205128">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p10395103115182">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p16449439205128">Object</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p1672891161318">Specifies the metadata of the rebuilt ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row32218260205027"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p2194767205128">imageRef</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p339610315183">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p43558409205128">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p37180395205128">Specifies the image ID or URL.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row9353828101214"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p16353828151216">adminPass</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p12396183110189">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p179096118134">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p20354192813125">Specifies the password for logging in to the rebuilt ECS. This parameter does not take effect.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row1071203310123"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p793719508123">OS-DCF:diskConfig</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p53961031141813">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p489821151317">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p1779133118132">Not supported</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row10417162481217"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p989235491212">preserve_ephemeral</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p1539673112183">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p3418172481218">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p4418112471220">Specifies whether to retain the temporary disk. This parameter is not supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__row2615592185"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__p162596184">key_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p7396123181820">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__p196105911183">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__p14625910182">Specifies the key pair name. If the value is null, the existing key pair is left blank.</p>
<p id="EN-US_TOPIC_0065817688__p1613950102115">This parameter is supported in microversion 2.54 and later.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__row1412464616713"><td class="cellrowborder" valign="top" width="19.950000000000003%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817688__p24211473719">user_data</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817688__p13396163118181">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.04%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817688__p1542110471478">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.190000000000005%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817688__p13421447279">Specifies the user data to be injected during the <span id="EN-US_TOPIC_0065817688__text86731033192216">ECS</span> creation. This is an extended attribute. Text and text files can be injected.</p>
<div class="note" id="EN-US_TOPIC_0065817688__note1076765671813"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0065817688__ul749201611912"><li id="EN-US_TOPIC_0065817688__li67541847182119">The content of <strong id="EN-US_TOPIC_0065817688__b1499711443816">user_data</strong> must be encoded with base64.</li><li id="EN-US_TOPIC_0065817688__li84921116141913">The maximum size of the content to be injected (before encoding) is 32 KB.</li></ul>
</div></div>
<p id="EN-US_TOPIC_0065817688__p151383081516">For more information about the user data to be injected, see "Injecting User Data into ECSs" in <em id="EN-US_TOPIC_0065817688__i8986202811421">Elastic Cloud Server User Guide</em>.</p>
<p id="EN-US_TOPIC_0065817688__p1633783620117">Examples</p>
<p id="EN-US_TOPIC_0065817688__p12545313524">Before base64 encoding:</p>
<ul id="EN-US_TOPIC_0065817688__ul13541314520"><li id="EN-US_TOPIC_0065817688__li13546312528">Linux<pre class="screen" id="EN-US_TOPIC_0065817688__screen16541531125220">#!/bin/bash
echo user_test &gt; /home/user.txt</pre>
</li><li id="EN-US_TOPIC_0065817688__li0541731105219">Windows<pre class="screen" id="EN-US_TOPIC_0065817688__screen35418316520">rem cmd
echo 111 &gt; c:\aaa.txt</pre>
</li></ul>
<p id="EN-US_TOPIC_0065817688__p16762152318318">After base64 encoding:</p>
<ul id="EN-US_TOPIC_0065817688__ul2069415489311"><li id="EN-US_TOPIC_0065817688__li126941548163113">Linux<pre class="screen" id="EN-US_TOPIC_0065817688__screen1769415480317">IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==</pre>
</li><li id="EN-US_TOPIC_0065817688__li06941485319">Windows<pre class="screen" id="EN-US_TOPIC_0065817688__screen1969444873114">cmVtIGNtZAplY2hvIDExMSA+IGM6XGFhYS50eHQ=</pre>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section3406845205255"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817688__p84921134145812"><a href="#EN-US_TOPIC_0065817688__en-us_topic_0058745339_table49173801205341">Table 4</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table49173801205341"></a><a name="en-us_topic_0058745339_table49173801205341"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_table49173801205341" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row38681531205341"><th align="left" class="cellrowborder" valign="top" width="28.73712628737126%" id="mcps1.3.7.3.2.4.1.1"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p6106389205358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.98770122987701%" id="mcps1.3.7.3.2.4.1.2"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p24855533205358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.27517248275173%" id="mcps1.3.7.3.2.4.1.3"><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p2614453205358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row39606926205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p43945661205412">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p2828827205412">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p974868915521">Specifies the ECS status.</p>
<p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5554125915523">Values:</p>
<ul id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_ul4409511215559"><li id="EN-US_TOPIC_0065817688__li4334784115559"><strong id="EN-US_TOPIC_0065817688__b1404992615559">ACTIVE</strong></li><li id="EN-US_TOPIC_0065817688__li6493204315559"><strong id="EN-US_TOPIC_0065817688__b5934047815559">REBOOT</strong></li><li id="EN-US_TOPIC_0065817688__li4153474615559"><strong id="EN-US_TOPIC_0065817688__b6430225415559">HARD_REBOOT</strong></li><li id="EN-US_TOPIC_0065817688__li2468030615559"><strong id="EN-US_TOPIC_0065817688__b4184937615559">REBUILD</strong></li><li id="EN-US_TOPIC_0065817688__li1132524115559"><strong id="EN-US_TOPIC_0065817688__b4110007015559">MIGRATING</strong></li><li id="EN-US_TOPIC_0065817688__li437967715559"><strong id="EN-US_TOPIC_0065817688__b3435631115559">BUILD</strong></li><li id="EN-US_TOPIC_0065817688__li4512289815559"><strong id="EN-US_TOPIC_0065817688__b4077135015559">SHUTOFF</strong></li><li id="EN-US_TOPIC_0065817688__li3878779715559"><strong id="EN-US_TOPIC_0065817688__b3139783515559">RESIZE</strong></li><li id="EN-US_TOPIC_0065817688__li2220663415559"><strong id="EN-US_TOPIC_0065817688__b1414506315559">VERIFY_RESIZE</strong></li><li id="EN-US_TOPIC_0065817688__li3949468915559"><strong id="EN-US_TOPIC_0065817688__b6019670715559">ERROR</strong></li><li id="EN-US_TOPIC_0065817688__li2176078015559"><strong id="EN-US_TOPIC_0065817688__b489945615559">DELETED</strong></li></ul>
<p id="EN-US_TOPIC_0065817688__p98198168558">For details, see <a href="en-us_topic_0178420672.html">ECS Statuses</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row18260674205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p41230700205412">updated</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p51352393205412">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p36554948205412">Specifies the time when the ECS was updated last time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row58340703205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p6338506205412">hostId</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p43657009205412">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p13004714205412">Specifies the ID of the host on which the ECS is deployed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row11730016205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p18087298205412">addresses</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p55785035205412">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p60985304205412">Specifies the network attribute of the ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row2865349205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p32218820205412">links</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p59587610205412">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p45182573205412">Describes the ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row12453079205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p54752905205412">image</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5800295205412">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5010132205412">Specifies the ECS image information. For the ECS that boots from a volume, the value is left blank.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row40450152205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p28507858205412">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p27435137205412">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p15962877205412">Specifies the ECS flavor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row8503055205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p27103976205412">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p47938434205412">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p51933601205412">Specifies the ECS ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row13299823205341"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p10195868205412">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p20558988205412">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p65814145205412">Specifies the user UUID of the ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row44286797202934"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p28836818203017">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p54080902203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p20236732203017">Specifies the ECS name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row26755982202937"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p55736572203017">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p18368516203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p55424556203017">Specifies the UUID of the tenant who owns the ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row43950511202941"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p4965641203017">OS-DCF:diskConfig</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p66672654203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p23709405203017">Specifies the diskConfig type. It is an extended attributed.</p>
<ul id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_ul12058054203017"><li id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_li41413623203017"><strong id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_b19223538">MANUAL</strong>: The image space cannot be expanded.</li><li id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_li37178289203017"><strong id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_b13602746">AUTO</strong>: The image space on the system disk will be automatically expanded to keep the same as that set in the flavor.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row10229070202944"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p58100889203017">accessIPv4</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p8551536203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p3622325203017">Discarded</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row35508689202947"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p23429640203017">accessIPv6</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p18752687203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p25834270203017">Discarded</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row37751476202950"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p42701424203017">progress</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p36263280203017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p22458237203017">Specifies the ECS creation progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_row6638586820302"><td class="cellrowborder" valign="top" width="28.73712628737126%" headers="mcps1.3.7.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p64601528203017">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="22.98770122987701%" headers="mcps1.3.7.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p65341292203017">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.27517248275173%" headers="mcps1.3.7.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p12793900203017">Specifies the ECS metadata.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section6318101715279"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0065817688__p697116918344">Use the <strong id="EN-US_TOPIC_0065817688__b1941311503596">3ed456f5-3d8f-4383-a6c9-312032afcd1a</strong> image to rebuild an ECS.</p>
<pre class="screen" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_screen698625318278">POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
{
"rebuild" : {
"imageRef" : "3ed456f5-3d8f-4383-a6c9-312032afcd1a",
"name" : "rebuildName",
"metadata" : {
"rebuild" : "rebuild vm"
}
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__section1515353712613"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817688__screen118619378615">{
"server": {
"tenant_id": "7459f9935ed2422eb9800fea1d4d9378",
"image": {
"links": [
{
"rel": "bookmark",
"href": "https://<em id="EN-US_TOPIC_0065817688__i612305720356">xxx</em>/7459f9935ed2422eb9800fea1d4d9378/images/3ed456f5-3d8f-4383-a6c9-312032afcd1a"
}
],
"id": "3ed456f5-3d8f-4383-a6c9-312032afcd1a"
},
"accessIPv4": "",
"addresses": {
"443dd9e3-c165-4764-ad92-b17fcf12a3eb": [
{
"addr": "192.168.0.119",
"version": 4
}
]
},
"metadata": {
"name": "rebuildName"
},
"accessIPv6": "",
"created": "2016-09-19T01:13:26Z",
"hostId": "fd16ebd9c2629e8595875cc1e1400fa67f392431d7937fcc9cf37671",
"adminPass": "qGVjnEjY3ZoY",
"flavor": {
"links": [
{
"rel": "bookmark",
"href": "https://<em id="EN-US_TOPIC_0065817688__i173587411369">xxx</em>/7459f9935ed2422eb9800fea1d4d9378/flavors/s3.xlarge.1"
}
],
"id": "s3.xlarge.1"
},
"OS-DCF:diskConfig": "MANUAL",
"user_id": "ed2965d80d394be0b41e56f50ac650ca",
"name": "rebuildName",
"progress": 0,
"links": [
{
"rel": "self",
"href": "https://<em id="EN-US_TOPIC_0065817688__i996201013361">xxx</em>/v2/7459f9935ed2422eb9800fea1d4d9378/servers/ea681a24-9b24-4f49-98ef-8e1f73acf19e"
},
{
"rel": "bookmark",
"href": "https://<em id="EN-US_TOPIC_0065817688__i6522313143612">xxx</em>/7459f9935ed2422eb9800fea1d4d9378/servers/ea681a24-9b24-4f49-98ef-8e1f73acf19e"
}
],
"id": "ea681a24-9b24-4f49-98ef-8e1f73acf19e",
"updated": "2016-09-19T07:22:05Z",
"status": "REBUILD"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_section128741313191616"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817688__en-us_topic_0058745339_p5693111841619">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>
View Git Blame Copy Permalink