forked from docs/doc-exports
wanghuijuan738
8f024b87ae
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com> Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
1020 lines
108 KiB
HTML
1020 lines
108 KiB
HTML
<a name="EN-US_TOPIC_0020212668"></a><a name="EN-US_TOPIC_0020212668"></a>
|
|
|
|
<h1 class="topictitle1">Creating <span id="text18117181111218">ECS</span>s</h1>
|
|
<div id="body38061996"><div class="section" id="EN-US_TOPIC_0020212668__section61372619"><a name="EN-US_TOPIC_0020212668__section61372619"></a><a name="section61372619"></a><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212668__p63122796">This API is used to create one or more ECSs.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p131101754194812">This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean that the creation is complete. You need to call the API by referring to <a href="en-us_topic_0022225398.html">Querying Job Execution Status</a> to query the job status. The <strong id="EN-US_TOPIC_0020212668__b12297760591">SUCCESS</strong> status indicates that the creation is successful.</p>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p688492443210">Before calling this API, you need to obtain <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">regions and endpoints</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p599644618118">Logging in to an <span id="EN-US_TOPIC_0020212668__text9312133810452">ECS</span> can be authenticated using either a key pair or password. For security purposes, you are advised to use key pair authentication.</p>
|
|
<ul id="EN-US_TOPIC_0020212668__en-us_topic_0013859510_ul48963016215158"><li id="EN-US_TOPIC_0020212668__en-us_topic_0013859510_li38304700215158">Key pair<p id="EN-US_TOPIC_0020212668__en-us_topic_0013859510_p37613652183921"><a name="EN-US_TOPIC_0020212668__en-us_topic_0013859510_li38304700215158"></a><a name="en-us_topic_0013859510_li38304700215158"></a>A key pair is used for <span id="EN-US_TOPIC_0020212668__text398420394455">ECS</span> login authentication.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p240161911714">Method of calling APIs: Use the <strong id="EN-US_TOPIC_0020212668__b18371121611519">key_name</strong> field to specify the key file used for logging in to the <span id="EN-US_TOPIC_0020212668__text725734116452">ECS</span>.</p>
|
|
</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0013859510_li64799030183852">Password<p id="EN-US_TOPIC_0020212668__en-us_topic_0013859510_p6641315318409"><a name="EN-US_TOPIC_0020212668__en-us_topic_0013859510_li64799030183852"></a><a name="en-us_topic_0013859510_li64799030183852"></a>If you choose the initial password for authentication in an <span id="EN-US_TOPIC_0020212668__text93561716142116">ECS</span>, you can log in to the <span id="EN-US_TOPIC_0020212668__text1335611642110">ECS</span> using the username and its initial password. The initial password of user <strong id="EN-US_TOPIC_0020212668__b14356161612213">root</strong> is used for authentication in Linux, while that of user <strong id="EN-US_TOPIC_0020212668__b2356141613217">Administrator</strong> is used for authentication in Windows.</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p115739361915">Method of calling APIs: Use the <strong id="EN-US_TOPIC_0020212668__b171961350193610">adminPass</strong> field to specify the initial login password of the administrator account. For details about how to use the <strong id="EN-US_TOPIC_0020212668__b1336945213612">adminPass</strong> field, see <a href="#EN-US_TOPIC_0020212668__table761103195216">Table 3</a>. If an encrypted password is required for logging in to a Linux <span id="EN-US_TOPIC_0020212668__text16435192610213">ECS</span> that is created using an image with Cloud-Init installed, you can use the <strong id="EN-US_TOPIC_0020212668__b12808645126">user_data</strong> field to inject the password. For details, see <a href="#EN-US_TOPIC_0020212668__table761103195216">Table 3</a>.<div class="note" id="EN-US_TOPIC_0020212668__note481424942414"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0020212668__p1081594982420">If the <strong id="EN-US_TOPIC_0020212668__b6419553104317">user_data</strong> field is specified for a Linux <span id="EN-US_TOPIC_0020212668__text19419155318434">ECS</span> that is created using an image with Cloud-Init installed, the <strong id="EN-US_TOPIC_0020212668__b10420115316439">adminPass</strong> field becomes invalid.</p>
|
|
</div></div>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0020212668__li452864023912">Image password<p id="EN-US_TOPIC_0020212668__p681875194112"><a name="EN-US_TOPIC_0020212668__li452864023912"></a><a name="li452864023912"></a>If you use a Linux private image to create an ECS, you can use the image password for login authentication.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p12823195517424">Method of calling APIs: If the image password is used, the <strong id="EN-US_TOPIC_0020212668__b12355423181717">key_name</strong> and <strong id="EN-US_TOPIC_0020212668__b63551623171710">adminPass</strong> fields do not need to be specified.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section15482662"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212668__p66228246145352">POST /v1/{project_id}/cloudservers</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p98566196355"><a href="#EN-US_TOPIC_0020212668__table55945983">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__table55945983"></a><a name="table55945983"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table55945983" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__row11302482"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.3.2.2.4.1.1"><p id="EN-US_TOPIC_0020212668__p43085863">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.3.2.2.4.1.2"><p id="EN-US_TOPIC_0020212668__p294000">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.5.3.2.2.4.1.3"><p id="EN-US_TOPIC_0020212668__p23814038">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row49888896"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212668__p14468758">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212668__p31118786">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.5.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212668__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section5126234"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020212668__p3320856183512"><strong id="EN-US_TOPIC_0020212668__b3649127123711">Request parameters</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p201561419366"><a href="#EN-US_TOPIC_0020212668__en-us_topic_0057972661_table40519951">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__en-us_topic_0057972661_table40519951"></a><a name="en-us_topic_0057972661_table40519951"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_table40519951" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_row35619075"><th align="left" class="cellrowborder" valign="top" width="13.990099009900991%" id="mcps1.3.6.4.2.5.1.1"><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p66572856">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.138613861386139%" id="mcps1.3.6.4.2.5.1.2"><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p23692278">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.910891089108908%" id="mcps1.3.6.4.2.5.1.3"><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p40026340">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.96039603960396%" id="mcps1.3.6.4.2.5.1.4"><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p20908074">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_row15832433"><td class="cellrowborder" valign="top" width="13.990099009900991%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p7358688">server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.138613861386139%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p59182880">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.910891089108908%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p29083993">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.96039603960396%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p8511051102515"><strong id="EN-US_TOPIC_0020212668__b36940689342237">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__en-us_topic_0057972661_p6993202">Specifies the <span id="EN-US_TOPIC_0020212668__text2464154414511">ECS</span> information. For details, see <a href="#EN-US_TOPIC_0020212668__table761103195216">Table 3</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p6313454112517"><strong id="EN-US_TOPIC_0020212668__b304886684356">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1121455152616">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p555445713265"><strong id="EN-US_TOPIC_0020212668__b30074225942954">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p13911013271">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p873014214273"><strong id="EN-US_TOPIC_0020212668__b212367680244225">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p153351493271">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1127773764718"><td class="cellrowborder" valign="top" width="13.990099009900991%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p531711654214">dry_run</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.138613861386139%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p123174168425">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.910891089108908%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p5317111619420">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.96039603960396%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p331254134411"><strong id="EN-US_TOPIC_0020212668__b124026192173">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p935233824220">Specifies whether to check the request. If this parameter is set to <strong id="EN-US_TOPIC_0020212668__b10897928182120">true</strong>, no instance is created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1947651444410"><strong id="EN-US_TOPIC_0020212668__b106201458111814">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p9113191017818">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p134115232817"><strong id="EN-US_TOPIC_0020212668__b105751106195">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul16884162818139"><li id="EN-US_TOPIC_0020212668__li47643211376"><strong id="EN-US_TOPIC_0020212668__b1449618368219">true</strong>: Check the request. Check items include the mandatory parameters and request format.<ul id="EN-US_TOPIC_0020212668__ul14785162314512"><li id="EN-US_TOPIC_0020212668__li166117194456">If the check fails, the system returns an error.</li><li id="EN-US_TOPIC_0020212668__li7618819164517">If the check is successful, the system returns status code 202.</li></ul>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0020212668__ul10553175316137"><li id="EN-US_TOPIC_0020212668__li151121824311"><strong id="EN-US_TOPIC_0020212668__b11272923918">false</strong>: Send the request without checking the request body.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p0419830144411"><strong id="EN-US_TOPIC_0020212668__b111161712193">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17340203120436">false</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__table761103195216"></a><a name="table761103195216"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table761103195216" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters for creating an <span id="EN-US_TOPIC_0020212668__text14620193382112">ECS</span></caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__row6501318520"><th align="left" class="cellrowborder" valign="top" width="16.666666666666668%" id="mcps1.3.6.5.2.5.1.1"><p id="EN-US_TOPIC_0020212668__p107278674213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.686274509803921%" id="mcps1.3.6.5.2.5.1.2"><p id="EN-US_TOPIC_0020212668__p13742669429">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.6.5.2.5.1.3"><p id="EN-US_TOPIC_0020212668__p1874212611429">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.882352941176464%" id="mcps1.3.6.5.2.5.1.4"><p id="EN-US_TOPIC_0020212668__p77581261423">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row145143105220"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p450031105218">imageRef</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p25133117527">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p155173185218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p011891293214"><strong id="EN-US_TOPIC_0020212668__b439916547189">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p15183125212">Specifies the ID of the system image used for creating <span id="EN-US_TOPIC_0020212668__text79522043102114">ECS</span>s. The ID is in the format of a Universally Unique Identifier (UUID).</p>
|
|
<p id="EN-US_TOPIC_0020212668__p280873817134">You can obtain the image ID from the console or by following the instructions provided in "Querying Images" in <em id="EN-US_TOPIC_0020212668__i1117005219212">Image Management Service API Reference</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p628541219311"><strong id="EN-US_TOPIC_0020212668__b1562275815187">Constraints</strong></p>
|
|
<div class="note" id="EN-US_TOPIC_0020212668__note20483193115317"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0020212668__en-us_topic_0068473331_ul185629592115"><li id="EN-US_TOPIC_0020212668__en-us_topic_0068473331_li155622595111">Certain <span id="EN-US_TOPIC_0020212668__text062712555219">ECS</span> flavors cannot support all public images provided on the cloud platform. To obtain the images supported by an <span id="EN-US_TOPIC_0020212668__text58721945174511">ECS</span> flavor, log in to the management console, view the images displayed on the <strong id="EN-US_TOPIC_0020212668__b842352706185454">Create <span id="EN-US_TOPIC_0020212668__text83349437215">ECS</span></strong> page, and obtain the image IDs on the <strong id="EN-US_TOPIC_0020212668__b842352706185522">Image Management Service</strong> page.</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0068473331_li16562859217">If the creation fails, modify the parameter settings.</li></ul>
|
|
</div></div>
|
|
<p id="EN-US_TOPIC_0020212668__p2693025191811"><strong id="EN-US_TOPIC_0020212668__b13576131017196">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1950013233316">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p17693225141814"><strong id="EN-US_TOPIC_0020212668__b812201731917">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p111141827123119">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row155233165214"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p5515317522">flavorRef</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p45113165219">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p5510313525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p16414114964013"><strong id="EN-US_TOPIC_0020212668__b1140175415188">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p124996526158">Specifies the flavor ID of the <span id="EN-US_TOPIC_0020212668__text197803388219">ECS</span> to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p14521031105216">For details about the flavors that have been released, see "ECS Specifications and Types" in <em id="EN-US_TOPIC_0020212668__i842352697151722">Elastic Cloud Server User Guide</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p54631445918"><strong id="EN-US_TOPIC_0020212668__b062385861810">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1287115445817">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p45274135599"><strong id="EN-US_TOPIC_0020212668__b3577810171917">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p26935542354">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p163871204593"><strong id="EN-US_TOPIC_0020212668__b101351751911">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1686315504199">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1652163155219"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p852153118529">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p652123195218">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p352203120525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p17946174713424"><strong id="EN-US_TOPIC_0020212668__b1540105419183">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p12521231135217">Specifies the <span id="EN-US_TOPIC_0020212668__text187331744143219">ECS</span> name.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1950293364320"><strong id="EN-US_TOPIC_0020212668__b962425810188">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul150217332439"><li id="EN-US_TOPIC_0020212668__li11502933104314">If more than one <span id="EN-US_TOPIC_0020212668__text750819233222">ECS</span> is to be created (the <strong id="EN-US_TOPIC_0020212668__b850812234227">count</strong> value is greater than <strong id="EN-US_TOPIC_0020212668__b450982332211">1</strong>), the system automatically adds a hyphen followed by a four-digit incremental number, such as <strong id="EN-US_TOPIC_0020212668__b450972372216">-0000</strong>, to the end of each <span id="EN-US_TOPIC_0020212668__text135091523122220">ECS</span> name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains 1 to 59 characters.</li><li id="EN-US_TOPIC_0020212668__li2161639113114"><span id="EN-US_TOPIC_0020212668__text9461182172412">ECS</span> hostnames comply with <a href="https://tools.ietf.org/html/rfc952" target="_blank" rel="noopener noreferrer">RFC 952</a> and <a href="https://tools.ietf.org/html/rfc1123" target="_blank" rel="noopener noreferrer">RFC 1123</a> naming rules. It is recommended that you configure hostnames using digits (0 to 9), lowercase letters (a to z), and hyphens (-). Underscores (_) are converted into hyphens (-) by default.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p195216316527"><strong id="EN-US_TOPIC_0020212668__b1457831010192">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p10616184224420">The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1487217510718"><strong id="EN-US_TOPIC_0020212668__b114181714193">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p5816171210713">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row17782101981517"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p1148283018154">user_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p248253012159">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p34981630181517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p0759302085"><strong id="EN-US_TOPIC_0020212668__b14021454151818">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p124835165514">Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1633783620117">Examples</p>
|
|
<p id="EN-US_TOPIC_0020212668__p12545313524">Before base64 encoding:</p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul13541314520"><li id="EN-US_TOPIC_0020212668__li13546312528">Linux<pre class="screen" id="EN-US_TOPIC_0020212668__screen16541531125220">#!/bin/bash
|
|
echo user_test > /home/user.txt</pre>
|
|
</li><li id="EN-US_TOPIC_0020212668__li0541731105219">Windows<pre class="screen" id="EN-US_TOPIC_0020212668__screen35418316520">rem cmd
|
|
echo 111 > c:\aaa.txt</pre>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p16762152318318">After base64 encoding:</p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul2069415489311"><li id="EN-US_TOPIC_0020212668__li126941548163113">Linux<pre class="screen" id="EN-US_TOPIC_0020212668__screen1769415480317">IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==</pre>
|
|
</li><li id="EN-US_TOPIC_0020212668__li06941485319">Windows<pre class="screen" id="EN-US_TOPIC_0020212668__screen1969444873114">cmVtIGNtZAplY2hvIDExMSA+IGM6XGFhYS50eHQ=</pre>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p151383081516">For more information about the user data to be injected, see "Injecting User Data into ECSs" in <em id="EN-US_TOPIC_0020212668__i24557219106">Elastic Cloud Server User Guide</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1081020351818"><strong id="EN-US_TOPIC_0020212668__b4625175818180">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul202253197417"><li id="EN-US_TOPIC_0020212668__li122571915416">The content of <strong id="EN-US_TOPIC_0020212668__b11904132002417">user_data</strong> must be encoded with base64.</li><li id="EN-US_TOPIC_0020212668__li15459121743">The maximum size of the content to be injected (before encoding) is 32 KB.</li><li id="EN-US_TOPIC_0020212668__li118110262465">If the <strong id="EN-US_TOPIC_0020212668__b187051423142413">user_data</strong> field is specified for a Linux <span id="EN-US_TOPIC_0020212668__text13705152362420">ECS</span> that is created using an image with Cloud-Init installed, the <strong id="EN-US_TOPIC_0020212668__b2706723162410">adminPass</strong> field becomes invalid.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p148274533017"><strong id="EN-US_TOPIC_0020212668__b1257916105191">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p55044411682">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1821545113019"><strong id="EN-US_TOPIC_0020212668__b8154174195">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p353511485813">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row155573112522"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p165493165214">adminPass</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p20541531105217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p64471619514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p136082119918"><strong id="EN-US_TOPIC_0020212668__b5404155411180">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p12995174416219">Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is <strong id="EN-US_TOPIC_0020212668__b108691110122915">root</strong>, and the Windows administrator is <strong id="EN-US_TOPIC_0020212668__b18869131015293">Administrator</strong>. For details, see <a href="#EN-US_TOPIC_0020212668__section61372619">Function</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p439533184820"><strong id="EN-US_TOPIC_0020212668__b11626558191813">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul12733118144816"><li id="EN-US_TOPIC_0020212668__li15244511217">The password cannot contain the username or the username in reverse.</li><li id="EN-US_TOPIC_0020212668__li192114592111">The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username.</li><li id="EN-US_TOPIC_0020212668__li52781844112318">If the <strong id="EN-US_TOPIC_0020212668__b976814372434">user_data</strong> field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the <strong id="EN-US_TOPIC_0020212668__b167683377431">adminPass</strong> field becomes invalid.</li><li id="EN-US_TOPIC_0020212668__li021425012311">If the <strong id="EN-US_TOPIC_0020212668__b188234116434">key_name</strong> field is specified for an ECS that is created using an image with Cloud-Init installed, the <strong id="EN-US_TOPIC_0020212668__b188234164320">adminPass</strong> field becomes invalid.</li></ul>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p1152014504224"><strong id="EN-US_TOPIC_0020212668__b9580111031914">Range</strong><ul id="EN-US_TOPIC_0020212668__ul52104519219"><li id="EN-US_TOPIC_0020212668__li1025452217">The password must contain 8 to 26 characters.</li><li id="EN-US_TOPIC_0020212668__li142114510215">The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p468112817913"><strong id="EN-US_TOPIC_0020212668__b31817178195">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p12155033598">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row155573175215"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p855531175218">key_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p16551131155216">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p1455163111526">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1450754917488"><strong id="EN-US_TOPIC_0020212668__b8405185421813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p055153115217">Specifies the name of the SSH key used for logging in to the <span id="EN-US_TOPIC_0020212668__text4452161102213">ECS</span>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p01371615133414">Keys can be created using the key creation API (<a href="en-us_topic_0020212678.html">Creating and Importing an SSH Key Pair</a>) or obtained using the SSH key query API (<a href="en-us_topic_0020212676.html">Listing SSH Key Pairs</a>).</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1271410277380"><strong id="EN-US_TOPIC_0020212668__b1262765819187">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p13691649109">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p15940203714386"><strong id="EN-US_TOPIC_0020212668__b4581191001913">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p640111321014">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p8966164253814"><strong id="EN-US_TOPIC_0020212668__b171941731915">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p185011821111020">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row13551231195216"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p14551831185218">vpcid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p2551031195211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p55543155218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p7652111713388"><strong id="EN-US_TOPIC_0020212668__b7406254111816">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p5551731125218">Specifies the ID of the VPC to which the <span id="EN-US_TOPIC_0020212668__text79086218229">ECS</span> belongs. The value is in the format of the UUID.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p56133115171910">You can obtain the VPC ID from the management console or by following the instructions provided in "Querying VPCs" in <em id="EN-US_TOPIC_0020212668__i4550823153416">Virtual Private Cloud API Reference</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1750728163919"><strong id="EN-US_TOPIC_0020212668__b36281658161810">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p2291143712102">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p12245105475617"><strong id="EN-US_TOPIC_0020212668__b10582131021919">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p144021943191014">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p4498133413394"><strong id="EN-US_TOPIC_0020212668__b142071716193">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p102451749161017">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row156133118524"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p1055123135212">nics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p35518315528">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p856731205215">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p201261685511"><strong id="EN-US_TOPIC_0020212668__b94071654131813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1756731175216">Specifies the NIC information of the <span id="EN-US_TOPIC_0020212668__text104131061221">ECS</span>. For details, see <a href="#EN-US_TOPIC_0020212668__table9120223">Table 4</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p13561731175218"><strong id="EN-US_TOPIC_0020212668__b66291458131812">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul14713548182"><li id="EN-US_TOPIC_0020212668__li975871645213">The value must be the ID of the subnet created in the VPC specified by <strong id="EN-US_TOPIC_0020212668__b84235270617196">vpcid</strong> and in the format of the UUID.</li></ul>
|
|
<ul id="EN-US_TOPIC_0020212668__ul125617317523"><li id="EN-US_TOPIC_0020212668__li20641181310319">A maximum of 12 NICs can be attached to an <span id="EN-US_TOPIC_0020212668__text94286752216">ECS</span>.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1638132524318"><strong id="EN-US_TOPIC_0020212668__b1583131011920">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p75149483124">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1360892419431"><strong id="EN-US_TOPIC_0020212668__b82171718198">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p10881851111214">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row45603125217"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p95618318528">publicip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p7563318521">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p75611317526">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p3496141464117"><strong id="EN-US_TOPIC_0020212668__b144081544181">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17561731155214">Specifies the EIP bound to the ECS, which can be configured in one of the following ways:</p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul1456133105216"><li id="EN-US_TOPIC_0020212668__li105693165211">Do not use: In such a case, this parameter is unavailable.</li><li id="EN-US_TOPIC_0020212668__li155653119529">Automatically assign: You need to specify the information about the EIP to be created.</li><li id="EN-US_TOPIC_0020212668__li195663175219">Use existing: You need to specify an existing EIP for your ECS.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p76591419152310">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table2785183710710">Table 1</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p153691755154317"><strong id="EN-US_TOPIC_0020212668__b136301858171815">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p2638416151313">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p11252214413"><strong id="EN-US_TOPIC_0020212668__b5584710201915">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p779112192138">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p182911013447"><strong id="EN-US_TOPIC_0020212668__b6221417171918">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p188542222130">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1457831155216"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p165613120523">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p175711312521">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p105793165216">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p105531646134119"><strong id="EN-US_TOPIC_0020212668__b44091154111813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1157203120522">Specifies the number of instances to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p195712318525"><strong id="EN-US_TOPIC_0020212668__b13631115813183">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul557183145214"><li id="EN-US_TOPIC_0020212668__li1557133105219">If this parameter is not specified, the default value is <strong id="EN-US_TOPIC_0020212668__b842352706165622">1</strong>.</li><li id="EN-US_TOPIC_0020212668__li1657183114526">If the tenant quota is sufficient, the maximum value is <strong id="EN-US_TOPIC_0020212668__b031335122715">100</strong>.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p72792135466"><strong id="EN-US_TOPIC_0020212668__b175857100191">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p128619814143">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p141873129468"><strong id="EN-US_TOPIC_0020212668__b423181731916">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1424141314143">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row25753155216"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p1457531155213">root_volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p857031115213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p157331165217">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p18489141445312"><strong id="EN-US_TOPIC_0020212668__b541015481814">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17571031115215">Specifies <span id="EN-US_TOPIC_0020212668__text538119128221">ECS</span> system disk configurations.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p59971231202312">For details, see <a href="#EN-US_TOPIC_0020212668__table53188122">Table 5</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p12489900523"><strong id="EN-US_TOPIC_0020212668__b6632458191813">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p19969161051518">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p201411576521"><strong id="EN-US_TOPIC_0020212668__b1258616106192">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p947121641513">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p150101216528"><strong id="EN-US_TOPIC_0020212668__b192581761913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p199991021151517">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1458183112527"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p1557203125216">data_volumes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p4571931185219">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p25733117524">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1077121712457"><strong id="EN-US_TOPIC_0020212668__b11411754101815">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p4581031115217">Specifies <span id="EN-US_TOPIC_0020212668__text1458721342218">ECS</span> data disk configurations. Each data structure represents a data disk to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p513873414513"><strong id="EN-US_TOPIC_0020212668__b2633105821820">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p45833113521">An <span id="EN-US_TOPIC_0020212668__text1577059691">ECS</span> can be attached with a maximum of 59 data disks (certain flavors support only 23 data disks).</p>
|
|
<p id="EN-US_TOPIC_0020212668__p269855113235">For details, see <a href="#EN-US_TOPIC_0020212668__table66739923">Table 6</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p430084119521"><strong id="EN-US_TOPIC_0020212668__b258716108194">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p9127124916160">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p6674346135219"><strong id="EN-US_TOPIC_0020212668__b1026171741915">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p14820184318162">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1659631185215"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p10581312525">security_groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p2581931185218">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p145813185212">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p4974217144610"><strong id="EN-US_TOPIC_0020212668__b1541205451813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1059123112521">Specifies the security groups of the <span id="EN-US_TOPIC_0020212668__text515571517226">ECS</span>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p6945115634618"><strong id="EN-US_TOPIC_0020212668__b1863418584180">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1159831155218">If this parameter is left blank, the default security group is bound to the <span id="EN-US_TOPIC_0020212668__text615711619221">ECS</span> by default.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p118678147244">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table1698566599">Table 2</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p10749454205315"><strong id="EN-US_TOPIC_0020212668__b958810101190">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p71028871717">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p819455918537"><strong id="EN-US_TOPIC_0020212668__b41110296545936">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p55490167178">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row185993115219"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p155933145215">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p1959143115529">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p2059133165210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p9477164617549"><strong id="EN-US_TOPIC_0020212668__b441305419187">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1059113114525">Specifies the name of the AZ where the <span id="EN-US_TOPIC_0020212668__text24489012406">ECS</span> is located.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p15187154018230">See <a href="en-us_topic_0065817728.html">Listing AZs</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p102031817195920"><strong id="EN-US_TOPIC_0020212668__b179091835195">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul386815581416"><li id="EN-US_TOPIC_0020212668__li11868185813419">If this parameter is not specified, the system automatically selects an AZ.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1017117236595"><strong id="EN-US_TOPIC_0020212668__b1558991018194">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p16838172041917">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p147312920592"><strong id="EN-US_TOPIC_0020212668__b91014346196">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p116622614198">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row18274658163916"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p3807173317380">batch_create_in_multi_az</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p18074331388">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p1580712339389">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1051023031416"><strong id="EN-US_TOPIC_0020212668__b104141154201817">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17588155913384">Specifies whether ECSs can be randomly deployed in multiple AZs.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p5520469224"><strong id="EN-US_TOPIC_0020212668__b1063511584186">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p14807433183812">This parameter is valid when <strong id="EN-US_TOPIC_0020212668__b8305135312298">availability_zone</strong> is left blank.</p>
|
|
<div class="note" id="EN-US_TOPIC_0020212668__note17481419184113"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020212668__p164811920415">When ECSs are created in batches, parameter <strong id="EN-US_TOPIC_0020212668__b47846428342">count</strong> is mandatory.</p>
|
|
</div></div>
|
|
<p id="EN-US_TOPIC_0020212668__p867203011120"><strong id="EN-US_TOPIC_0020212668__b1590171014198">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul1750773145619"><li id="EN-US_TOPIC_0020212668__li115071731185613"><strong id="EN-US_TOPIC_0020212668__b183012531626">true</strong>: The batch-created ECSs are deployed in multiple AZs.</li><li id="EN-US_TOPIC_0020212668__li15507331145611"><strong id="EN-US_TOPIC_0020212668__b663716201438">false</strong>: The batch-created ECSs are deployed in a single AZ.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p826313519117"><strong id="EN-US_TOPIC_0020212668__b112761781913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p8777195292113">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1259123185210"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p1959193111524">extendparam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p459931115218">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p559143112527">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p2123522137"><strong id="EN-US_TOPIC_0020212668__b1441545401818">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p759143185217">Provides the supplementary information about the <span id="EN-US_TOPIC_0020212668__text386761772217">ECS</span> to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1763154062412">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table1137234112314">Table 7</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p59012211117"><strong id="EN-US_TOPIC_0020212668__b163615871820">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p15841103412118">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p8643732125711"><strong id="EN-US_TOPIC_0020212668__b12590210191910">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p4210114282113">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p864373255714"><strong id="EN-US_TOPIC_0020212668__b13286178194">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p16643193215712">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row160631105219"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p5595317524">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p460131185220">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p1662104714508">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p10811124511716"><strong id="EN-US_TOPIC_0020212668__b3416115413182">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1460173115527">Specifies the metadata of the <span id="EN-US_TOPIC_0020212668__text11268921102218">ECS</span> to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p57411157124216">You can use metadata to customize key-value pairs. For details about reserved key-value pairs, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table2373623012315">Table 9</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p6343213591"><strong id="EN-US_TOPIC_0020212668__b1563819583181">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p989413225912">If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p176433426592"><strong id="EN-US_TOPIC_0020212668__b859215103194">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul14644164255917"><li id="EN-US_TOPIC_0020212668__li36441442155916">A maximum of 10 key-value pairs can be injected.</li><li id="EN-US_TOPIC_0020212668__li364414424596">A metadata key consists of 1 to 255 characters and can only contain uppercase letters, lowercase letters, spaces, digits, hyphens (-), underscores (_), colons (:), and periods (.).</li><li id="EN-US_TOPIC_0020212668__li15644642155919">A metadata value consists of a maximum of 255 characters.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p269218121006"><strong id="EN-US_TOPIC_0020212668__b13301917121913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p269281220013">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1460731155214"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p66010319528">os:scheduler_hints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p8601331145214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p176073116528">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p118341741809"><strong id="EN-US_TOPIC_0020212668__b341735412187">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p116011319521">Schedules <span id="EN-US_TOPIC_0020212668__text3916225221">ECS</span>s, for example, by configuring an ECS group.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p2052872152610">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table24430409172542">Table 10</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p070144219411"><strong id="EN-US_TOPIC_0020212668__b11639165819183">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p194456304235">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p20992848249"><strong id="EN-US_TOPIC_0020212668__b0593171071910">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1022715358236">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1529783892311"><strong id="EN-US_TOPIC_0020212668__b831617101917">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p195430541045">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row361143135218"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p106083115213">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p186193120522">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p661153112520">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p14421248082"><strong id="EN-US_TOPIC_0020212668__b674375821316">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p18469522412">Specifies <span id="EN-US_TOPIC_0020212668__text184791648131518">ECS</span> tags. A tag is in the format of "key.value".</p>
|
|
<p id="EN-US_TOPIC_0020212668__p14394163218820"><strong id="EN-US_TOPIC_0020212668__b7640115881812">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul1678234421012"><li id="EN-US_TOPIC_0020212668__li97821447102">Each <span id="EN-US_TOPIC_0020212668__text15953315161612">ECS</span> supports a maximum of 10 tags during the creation.</li><li id="EN-US_TOPIC_0020212668__li6782134416105">The <strong id="EN-US_TOPIC_0020212668__b1013181851612">server_tags</strong> field provides the same functions as <strong id="EN-US_TOPIC_0020212668__b1413116183164">tags</strong>, but supports more keys and values, so the <strong id="EN-US_TOPIC_0020212668__b1813119187165">server_tags</strong> field is recommended.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p20611731185211">A tag key contains a maximum of 36 characters, and a tag value contains a maximum of 43 characters.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p175339461818"><strong id="EN-US_TOPIC_0020212668__b20594010111912">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul10612319523"><li id="EN-US_TOPIC_0020212668__li8839912211">A tag key contains a maximum of 36 characters, and a tag value contains a maximum of 43 characters.</li><li id="EN-US_TOPIC_0020212668__li136272742413">The key of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).</li><li id="EN-US_TOPIC_0020212668__li157462742415">The value of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p107761012152414"><strong id="EN-US_TOPIC_0020212668__b53291713193">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1560955414811">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row13449312205016"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p12387312155010">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.686274509803921%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p43873126501">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p547665412509">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.882352941176464%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p192538185511"><strong id="EN-US_TOPIC_0020212668__b15419105451816">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p15756848134113">Specifies the <span id="EN-US_TOPIC_0020212668__text446112566180">ECS</span> description.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p588911221157"><strong id="EN-US_TOPIC_0020212668__b764115585186">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p12670571057">Angle brackets (<>) are not allowed.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p21404442518"><strong id="EN-US_TOPIC_0020212668__b1595181015193">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p205688591517">A maximum of 85 characters are allowed.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1988361342519"><strong id="EN-US_TOPIC_0020212668__b934101710199">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p15185102072510">Empty string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__table9120223"></a><a name="table9120223"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table9120223" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0020212668__b97758416625213">nics</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__row45607220"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.6.6.2.5.1.1"><p id="EN-US_TOPIC_0020212668__p1577344054216">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.6.2.5.1.2"><p id="EN-US_TOPIC_0020212668__p97891040194210">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.6.6.2.5.1.3"><p id="EN-US_TOPIC_0020212668__p1478994020422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.6.6.2.5.1.4"><p id="EN-US_TOPIC_0020212668__p0804144018428">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row56761457"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p34275314">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p24837051">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p65644149">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p5880129111316"><strong id="EN-US_TOPIC_0020212668__b942705419187">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p52170790174229">Specifies the subnet of the <span id="EN-US_TOPIC_0020212668__text1290819290226">ECS</span>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p13303627161317"><strong id="EN-US_TOPIC_0020212668__b965015831818">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p43287089174217">The value must be the ID of the subnet created in the VPC specified by <strong id="EN-US_TOPIC_0020212668__b593662663">vpcid</strong> and in the format of the UUID.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p9182213111915"><strong id="EN-US_TOPIC_0020212668__b56031210161911">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p862092019197">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p322932417194"><strong id="EN-US_TOPIC_0020212668__b144421741914">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p18306203171911">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row11285618104313"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p34461706104313">ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p39934810104313">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p13494158104313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p18301194517191"><strong id="EN-US_TOPIC_0020212668__b542819543188">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p28930193174245">Specifies the IP address of the NIC used by the <span id="EN-US_TOPIC_0020212668__text186606305226">ECS</span>. The value is an IPv4 address.</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p59045150174245"><strong id="EN-US_TOPIC_0020212668__b18651105817187">Constraints</strong><ul id="EN-US_TOPIC_0020212668__ul61644302174245"><li id="EN-US_TOPIC_0020212668__li17927812174245">If this parameter is left blank or set to <strong id="EN-US_TOPIC_0020212668__b842352706173944">""</strong>, an unused IP address in the subnet is automatically assigned as the IP address of the NIC.</li><li id="EN-US_TOPIC_0020212668__li64125911174254">If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p27061858161917"><strong id="EN-US_TOPIC_0020212668__b15604151011918">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p13847121418205">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1561916160209"><strong id="EN-US_TOPIC_0020212668__b14512179198">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p158539209204">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row48292797201232"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p31981994201232">binding:profile</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p40404711201232">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p95441454989">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p104616123149"><strong id="EN-US_TOPIC_0020212668__b942985421814">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p55491053202324">Allows you to customize data. For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table42451440577">Table 12</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1918205722013"><strong id="EN-US_TOPIC_0020212668__b365216588187">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1088514922313">This parameter can be specified only during the <span id="EN-US_TOPIC_0020212668__text668214222012">ECS</span> creation.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p31821157132015"><strong id="EN-US_TOPIC_0020212668__b16606181081915">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1218225782011">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p31829578202"><strong id="EN-US_TOPIC_0020212668__b546317161912">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p9182357102019">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row16036609201232"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p10111755201232">extra_dhcp_opts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p13745865201232">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p019211151690">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1358126112114"><strong id="EN-US_TOPIC_0020212668__b3430165441818">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p65187435417">Indicates extended DHCP options. For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table93959401279">Table 13</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1426231302113"><strong id="EN-US_TOPIC_0020212668__b18653185815187">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1026218139216">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p13262141310212"><strong id="EN-US_TOPIC_0020212668__b166079109195">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p122621813102115">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p122621613132114"><strong id="EN-US_TOPIC_0020212668__b19471317131912">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p92621313172111">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row47777151537"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p12341419175713">ipv6_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p677791510531">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p47771915145316">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p9644021156"><strong id="EN-US_TOPIC_0020212668__b3432125410182">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17772182665418">Specifies whether to support IPv6 addresses.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p9897173892218"><strong id="EN-US_TOPIC_0020212668__b1565419580187">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p19897133816222">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p58971238132212"><strong id="EN-US_TOPIC_0020212668__b96082010181911">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul1501123183819"><li id="EN-US_TOPIC_0020212668__li10511023163812"><strong id="EN-US_TOPIC_0020212668__b154611492203">true</strong>: The NIC supports IPv6.</li><li id="EN-US_TOPIC_0020212668__li152011627113810"><strong id="EN-US_TOPIC_0020212668__b598064910201">false</strong>: The NIC does not support IPv6.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1897153852213"><strong id="EN-US_TOPIC_0020212668__b44920178198">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p128976389228">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row467465612571"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p136741056145715">ipv6_bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p76741256185711">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p1267412565578">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p952551922320"><strong id="EN-US_TOPIC_0020212668__b1443225461813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p4674125655719">Specifies the bound shared bandwidth. For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__section2872318176">ipv6_bandwidth Field Description</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p20243765394"><strong id="EN-US_TOPIC_0020212668__b13655185871814">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p05741651183719">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p15879118388"><strong id="EN-US_TOPIC_0020212668__b360912107196">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1843016218383">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p125180593373"><strong id="EN-US_TOPIC_0020212668__b1250117191919">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p114151143814">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__table53188122"></a><a name="table53188122"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table53188122" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0020212668__b58171566625213">root_volume</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__row56379492"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.6.7.2.5.1.1"><p id="EN-US_TOPIC_0020212668__p748555484218">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.7.2.5.1.2"><p id="EN-US_TOPIC_0020212668__p1948517542420">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.881188118811881%" id="mcps1.3.6.7.2.5.1.3"><p id="EN-US_TOPIC_0020212668__p55012544426">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.43564356435643%" id="mcps1.3.6.7.2.5.1.4"><p id="EN-US_TOPIC_0020212668__p1451675411422">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row3514615"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p16248438">volumetype</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p41055134">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p37131542">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p17371126152512"><strong id="EN-US_TOPIC_0020212668__b34379548183">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p54864902">Specifies the disk type of an <span id="EN-US_TOPIC_0020212668__text9318163212218">ECS</span> system disk.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p297010308128">For details about disk types, see "Disk Types and Performance" in <em id="EN-US_TOPIC_0020212668__i82658614264">Elastic Volume Service User Guide</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p3420141482510"><strong id="EN-US_TOPIC_0020212668__b3660205881811">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul2815134217304"><li id="EN-US_TOPIC_0020212668__li381534203016">The disk type must match that provided by the system.</li><li id="EN-US_TOPIC_0020212668__li1881515422308">If the specified disk type is not available in the AZ specified by <strong id="EN-US_TOPIC_0020212668__b10749733103620">availability_zone</strong>, the disk creation will fail.</li><li id="EN-US_TOPIC_0020212668__li7464719183118">When the disk is created from a backup:<p id="EN-US_TOPIC_0020212668__p115392114313"><a name="EN-US_TOPIC_0020212668__li7464719183118"></a><a name="li7464719183118"></a>If the type of the backup's source disk is <strong id="EN-US_TOPIC_0020212668__b8186131815594">SSD</strong>, <strong id="EN-US_TOPIC_0020212668__b61871618145911">SAS</strong>, <strong id="EN-US_TOPIC_0020212668__b1818714180594">SATA</strong>, <strong id="EN-US_TOPIC_0020212668__b101871018135914">GPSSD</strong>, <strong id="EN-US_TOPIC_0020212668__b18188418125918">ESSD</strong>, or <strong id="EN-US_TOPIC_0020212668__b6188161815595">GPSSD2</strong>, you can create disks of any of these types.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p12546116310">If the type of the backup's source disk is <strong id="EN-US_TOPIC_0020212668__b102824416373">co-p1</strong> or <strong id="EN-US_TOPIC_0020212668__b5283124203715">uh-l1</strong>, you can create disks of any of the two types.</p>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1572527152518"><strong id="EN-US_TOPIC_0020212668__b761321010192">Range</strong></p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p12887229134510">The value can be <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b1623126121318">ESSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b423186151315">GPSSD2</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b623119621315">GPSSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b62311864139">SSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b112314601315">SAS</strong>, or <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b223126191316">SATA</strong>.<ul id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_ul13901722818"><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li15488111934310"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li0488119194318"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b769013365337">SAS</strong>: the high I/O type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li348881917438"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b581443819334">SATA</strong>: the common I/O type (end-of-sale)</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li1444614485511"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li17697121195818"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b529917133589">ESSD</strong>: the extreme SSD type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_li3722161919255"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b13477153410308">GPSSD2</strong>: the general purpose SSD V2 type</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p1061722712169"><strong id="EN-US_TOPIC_0020212668__b9546177192">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p6617927101617">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row60160519142638"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p11049419142649">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p22587748142649">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p17668334142649">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p554214311161"><strong id="EN-US_TOPIC_0020212668__b843865416184">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p21848977142649">Specifies the system disk size, in GiB.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p9898211364"><strong id="EN-US_TOPIC_0020212668__b866117588189">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul13190271969"><li id="EN-US_TOPIC_0020212668__li91901771968">The system disk size must be greater than or equal to the minimum system disk size supported by the image (<strong id="EN-US_TOPIC_0020212668__b842352706191837">min_disk</strong> attribute of the image).</li><li id="EN-US_TOPIC_0020212668__li21901673612">If this parameter is not specified or is set to <strong id="EN-US_TOPIC_0020212668__b842352706191921">0</strong>, the default system disk size is the minimum value of the system disk in the image (<strong id="EN-US_TOPIC_0020212668__b842352706191942">min_disk</strong> attribute of the image).</li></ul>
|
|
<div class="note" id="EN-US_TOPIC_0020212668__note995775414129"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020212668__p1427920232184">To obtain the minimum system disk size (<strong id="EN-US_TOPIC_0020212668__b13557135515524">min_disk</strong>) of an image, click the image on the management console for its details. Alternatively, call the native OpenStack API for querying details about an image. For details, see "Querying Image Details (Native OpenStack)" in <em id="EN-US_TOPIC_0020212668__i842352697142054">Image Management Service API Reference</em>.</p>
|
|
</div></div>
|
|
<p id="EN-US_TOPIC_0020212668__p1397123514618"><strong id="EN-US_TOPIC_0020212668__b136144103194">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p58831736182718">1 to 1024</p>
|
|
<p id="EN-US_TOPIC_0020212668__p05020282812"><strong id="EN-US_TOPIC_0020212668__b855817201917">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p59814397467">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1960625122419"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p9710802420">hw:passthrough</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p107208152412">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p147212852417">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p11756123631911"><strong id="EN-US_TOPIC_0020212668__b134424542186">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p4404163312419">Specifies the device type of the EVS disks to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1926811456198"><strong id="EN-US_TOPIC_0020212668__b96641658141815">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p6355211182113">N/A</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p85621127163915"><strong id="EN-US_TOPIC_0020212668__b19617111019193">Range</strong><ul id="EN-US_TOPIC_0020212668__ul128486424617"><li id="EN-US_TOPIC_0020212668__li1384894218611">If this parameter is set to <strong id="EN-US_TOPIC_0020212668__b1510492574416">false</strong>, VBD disks are created.</li><li id="EN-US_TOPIC_0020212668__li78481422616">If this parameter is set to <strong id="EN-US_TOPIC_0020212668__b111351331124414">true</strong>, SCSI disks are created.</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p10718131162014"><strong id="EN-US_TOPIC_0020212668__b259417141913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1816114313200">If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1595642172110"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p108721243102120">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p16872104382119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p4872194362118">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p132394724811"><strong id="EN-US_TOPIC_0020212668__b19443175415185">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p7872543152110">Specifies the metadata of the created EVS disk. For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__section1228814491353">metadata Field Description for Creating Disks</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p128452602220"><strong id="EN-US_TOPIC_0020212668__b12665125819186">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p115619286224">This parameter is used only when an encrypted disk is created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p229017348412"><strong id="EN-US_TOPIC_0020212668__b156181410171918">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p0601959154815">The length of <strong id="EN-US_TOPIC_0020212668__b82994014510">key</strong> and <strong id="EN-US_TOPIC_0020212668__b123000010451">value</strong> under <strong id="EN-US_TOPIC_0020212668__b16300180194517">metadata</strong> can contain no more than 255 bytes.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p2051364344114"><strong id="EN-US_TOPIC_0020212668__b18608171192">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p76071558498">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212668__table66739923"></a><a name="table66739923"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table66739923" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0020212668__b127215751725213">data_volumes</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__row64470080"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.6.8.2.5.1.1"><p id="EN-US_TOPIC_0020212668__p11191618194312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.6.8.2.5.1.2"><p id="EN-US_TOPIC_0020212668__p911916181439">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.121212121212121%" id="mcps1.3.6.8.2.5.1.3"><p id="EN-US_TOPIC_0020212668__p16135171819439">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.55555555555556%" id="mcps1.3.6.8.2.5.1.4"><p id="EN-US_TOPIC_0020212668__p2135131811433">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row11410990"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p51874972">volumetype</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p41123170">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p42642473">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p18423171615256"><strong id="EN-US_TOPIC_0020212668__b84456544189">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p31488280">Specifies the disk type of an <span id="EN-US_TOPIC_0020212668__text11963737192218">ECS</span> data disk.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p462815973213">For details about disk types, see "Disk Types and Performance" in <em id="EN-US_TOPIC_0020212668__i74867481128">Elastic Volume Service User Guide</em>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p528022465111"><strong id="EN-US_TOPIC_0020212668__b16668858151810">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul17411840122817"><li id="EN-US_TOPIC_0020212668__li18411154072818">The disk type must match that provided by the system.</li><li id="EN-US_TOPIC_0020212668__li1541184018283">If the specified disk type is not available in the AZ specified by <strong id="EN-US_TOPIC_0020212668__b15403520210">availability_zone</strong>, the disk creation will fail.</li><li id="EN-US_TOPIC_0020212668__li119211549313">When the disk is created from a backup:<p id="EN-US_TOPIC_0020212668__p203211655113115"><a name="EN-US_TOPIC_0020212668__li119211549313"></a><a name="li119211549313"></a>If the type of the backup's source disk is <strong id="EN-US_TOPIC_0020212668__b1984051536">SSD</strong>, <strong id="EN-US_TOPIC_0020212668__b1389354727">SAS</strong>, <strong id="EN-US_TOPIC_0020212668__b1785748336">SATA</strong>, <strong id="EN-US_TOPIC_0020212668__b2124915021">GPSSD</strong>, <strong id="EN-US_TOPIC_0020212668__b1649834819">ESSD</strong>, or <strong id="EN-US_TOPIC_0020212668__b2040209861">GPSSD2</strong>, you can create disks of any of these types.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1766518519310">If the type of the backup's source disk is <strong id="EN-US_TOPIC_0020212668__b25579557215">co-p1</strong> or <strong id="EN-US_TOPIC_0020212668__b205571755126">uh-l1</strong>, you can create disks of any of the two types.</p>
|
|
</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p034424012612"><strong id="EN-US_TOPIC_0020212668__b186211010201919">Range</strong></p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p1318375264116">The value can be <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b1623126121318_1">ESSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b423186151315_1">GPSSD2</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b623119621315_1">GPSSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b62311864139_1">SSD</strong>, <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b112314601315_1">SAS</strong>, or <strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b223126191316_1">SATA</strong>.<ul id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_ul13901722818_1"><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li15488111934310_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b2038683423316_1">SSD</strong>: the ultra-high I/O type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li0488119194318_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b769013365337_1">SAS</strong>: the high I/O type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li348881917438_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b581443819334_1">SATA</strong>: the common I/O type (end-of-sale)</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li1444614485511_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b616518497339_1">GPSSD</strong>: the general purpose SSD type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_en-us_topic_0094124248_li17697121195818_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b529917133589_1">ESSD</strong>: the extreme SSD type</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_li3722161919255_1"><strong id="EN-US_TOPIC_0020212668__en-us_topic_0000002310795292_b13477153410308_1">GPSSD2</strong>: the general purpose SSD V2 type</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p121925216521"><strong id="EN-US_TOPIC_0020212668__b1863017161916">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p19436189145216">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row14959071"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p3725214">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p33306906">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p13504826">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p98272717324"><strong id="EN-US_TOPIC_0020212668__b64461654171811">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p5562853216262">Specifies the data disk size, in GiB.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p186271136103217"><strong id="EN-US_TOPIC_0020212668__b106698589182">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17031848195810">When you use a data disk image to create a data disk, ensure that the value of this parameter is greater than or equal to the size of the source data disk that is used to create the data disk image.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p295975385113"><strong id="EN-US_TOPIC_0020212668__b146211410181914">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1163112465320">10 to 32768</p>
|
|
<p id="EN-US_TOPIC_0020212668__p9243203815314"><strong id="EN-US_TOPIC_0020212668__b181913571068">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p26175110520">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row36319805104741"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p58442796104741">shareable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p36246068104741">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p50250380104741">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1135331463320"><strong id="EN-US_TOPIC_0020212668__b044745411810">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p340879331257">Specifies whether the disk is shared.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p56651723135212"><strong id="EN-US_TOPIC_0020212668__b126696582185">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p553318598398">This parameter has been discarded. Use <strong id="EN-US_TOPIC_0020212668__b19537538618">multiattach</strong>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__en-us_topic_0020212668_p340879331257"><strong id="EN-US_TOPIC_0020212668__b13622171013195">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul856314498546"><li id="EN-US_TOPIC_0020212668__li1756413491545"><strong id="EN-US_TOPIC_0020212668__b16139405720">true</strong>: indicates that the created disk is a shared disk.</li><li id="EN-US_TOPIC_0020212668__li195647497542"><strong id="EN-US_TOPIC_0020212668__b3201930698">false</strong>: indicates that the created disk is a common EVS disk.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1098719305547"><strong id="EN-US_TOPIC_0020212668__b2064141781913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p47087321524">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row5795350214188"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p5181947414188">multiattach</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p3662789014188">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p1406913114188">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p167411925174012"><strong id="EN-US_TOPIC_0020212668__b1244815421812">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p6585779614188">Specifies the shared disk information.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p433155125518"><strong id="EN-US_TOPIC_0020212668__b46700588187">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p474455411409">The <strong id="EN-US_TOPIC_0020212668__b155098570914">shareable</strong> parameter is discarded. If both <strong id="EN-US_TOPIC_0020212668__b165091957992">shareable</strong> and <strong id="EN-US_TOPIC_0020212668__b250985713916">multiattach</strong> must be used, ensure that the values of the two parameters are the same. If this parameter is not specified, common EVS disks are created by default.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1745465514011"><strong id="EN-US_TOPIC_0020212668__b4623131091912">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul303285995535"><li id="EN-US_TOPIC_0020212668__li3845249295535"><strong id="EN-US_TOPIC_0020212668__b84235270620220">true</strong>: indicates that the created disk is a shared disk.</li><li id="EN-US_TOPIC_0020212668__li2458486295535"><strong id="EN-US_TOPIC_0020212668__b84235270620526">false</strong>: indicates that the created disk is a common EVS disk.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p19457207556"><strong id="EN-US_TOPIC_0020212668__b16511771913">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1485619345461">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row1051569714183"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p2753241214183">hw:passthrough</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p1553286914183">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p5020283814183">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p710813375313"><strong id="EN-US_TOPIC_0020212668__b1644965418184">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p4088945310517">Specifies the device type of the EVS disks to be created.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p165466571232"><strong id="EN-US_TOPIC_0020212668__b196711858151815">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p18265119427">N/A</p>
|
|
<div class="p" id="EN-US_TOPIC_0020212668__p096611914416"><strong id="EN-US_TOPIC_0020212668__b562471031919">Range</strong><ul id="EN-US_TOPIC_0020212668__en-us_topic_0020212668_ul128486424617"><li id="EN-US_TOPIC_0020212668__en-us_topic_0020212668_li1384894218611">If this parameter is set to <strong id="EN-US_TOPIC_0020212668__b1649598988">false</strong>, VBD disks are created.</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0020212668_li78481422616">If this parameter is set to <strong id="EN-US_TOPIC_0020212668__b1737496069">true</strong>, SCSI disks are created.</li><li id="EN-US_TOPIC_0020212668__en-us_topic_0020212668_li48498421766">If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.</li></ul>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p10712644242"><strong id="EN-US_TOPIC_0020212668__b10661117181918">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p10113115125315">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row26398748122322"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p48878066122327">extendparam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p66809250122327">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p42840179122327">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p133282218533"><strong id="EN-US_TOPIC_0020212668__b1244917543185">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p24869108122327">Provides the disk information.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p182541631152818">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__table7562101331712">Table 6</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p3298868519"><strong id="EN-US_TOPIC_0020212668__b10672165812185">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17293926195312">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p5685161318511"><strong id="EN-US_TOPIC_0020212668__b15624201018198">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p18330103313531">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p435510206514"><strong id="EN-US_TOPIC_0020212668__b76715178197">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p32916390531">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row62177020217"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p5036340620217">data_image_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p5290411520217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p5737494520217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p98691044195419"><strong id="EN-US_TOPIC_0020212668__b945385411181">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p37344069202225">Specifies ID of the data image. The value is in UUID format.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p62909507546"><strong id="EN-US_TOPIC_0020212668__b867519587186">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p844532810467">If data disks are created using a data disk image, this parameter is mandatory and it does not support metadata.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p9573021171815"><strong id="EN-US_TOPIC_0020212668__b1262711103194">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p20283455125413">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p68971927161813"><strong id="EN-US_TOPIC_0020212668__b167210177196">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1615417310558">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row17444062585"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.6.8.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__p164461462581">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.6.8.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__p174476613587">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.6.8.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__p296112276588">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.6.8.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p0713104895611"><strong id="EN-US_TOPIC_0020212668__b1445412548184">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p156482674519">Specifies the metadata of the created EVS disk.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p16970151531615">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__section1228814491353">metadata Field Description for Creating Disks</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p0643925197"><strong id="EN-US_TOPIC_0020212668__b106761458101820">Constraints</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul7371203215451"><li id="EN-US_TOPIC_0020212668__li20371732114511">The length of <strong id="EN-US_TOPIC_0020212668__b33040951319">key</strong> and <strong id="EN-US_TOPIC_0020212668__b030515941316">value</strong> under <strong id="EN-US_TOPIC_0020212668__b43057913137">metadata</strong> can contain no more than 255 bytes.</li><li id="EN-US_TOPIC_0020212668__li63711324457">This parameter is used only when an encrypted disk is created.</li><li id="EN-US_TOPIC_0020212668__li143712032184516">If data disks are created using a data disk image, this parameter cannot be used.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p14182115591918"><strong id="EN-US_TOPIC_0020212668__b126282010171918">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1560816567566">N/A</p>
|
|
<p id="EN-US_TOPIC_0020212668__p169190315208"><strong id="EN-US_TOPIC_0020212668__b107361761920">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p973422125719">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table76131051294" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0020212668__b128424532595838">security_options</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_row139423462209"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.6.9.2.5.1.1"><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p1594274611204">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.13%" id="mcps1.3.6.9.2.5.1.2"><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p18942154612208">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.01%" id="mcps1.3.6.9.2.5.1.3"><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p1594224610201">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.86%" id="mcps1.3.6.9.2.5.1.4"><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p0942194622011">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_row07034892110"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.6.9.2.5.1.1 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p1370310817218">tpm_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.13%" headers="mcps1.3.6.9.2.5.1.2 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p107031983212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.01%" headers="mcps1.3.6.9.2.5.1.3 "><p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p47030810212">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.86%" headers="mcps1.3.6.9.2.5.1.4 "><p id="EN-US_TOPIC_0020212668__p1940728201"><strong id="EN-US_TOPIC_0020212668__b2460155410189">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__en-us_topic_0093055772_en-us_topic_0093055772_p107031788218">Specifies whether to enable TPM.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p1439912915018"><strong id="EN-US_TOPIC_0020212668__b968215819189">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p17981187201618">Currently, the following instance types support TPM: Pi5e.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p739917916010"><strong id="EN-US_TOPIC_0020212668__b206339107197">Range</strong></p>
|
|
<ul id="EN-US_TOPIC_0020212668__ul33991391205"><li id="EN-US_TOPIC_0020212668__li173991399016"><strong id="EN-US_TOPIC_0020212668__b765719417172">true</strong>: Enable TPM.</li><li id="EN-US_TOPIC_0020212668__li163993917015"><strong id="EN-US_TOPIC_0020212668__b14744141218179">false</strong>: Disable TPM.</li></ul>
|
|
<p id="EN-US_TOPIC_0020212668__p1039916911013"><strong id="EN-US_TOPIC_0020212668__b9801517111911">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p113998917012">false</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section46136113"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212668__table2824153181913" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020212668__row11825193111915"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.7.2.1.4.1.1"><p id="EN-US_TOPIC_0020212668__p135632102272">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.7.2.1.4.1.2"><p id="EN-US_TOPIC_0020212668__p55632010102714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.34653465346535%" id="mcps1.3.7.2.1.4.1.3"><p id="EN-US_TOPIC_0020212668__p125631410152717">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020212668__row382615381910"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.7.2.1.4.1.1 "><p id="EN-US_TOPIC_0020212668__p1882713151914">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.7.2.1.4.1.2 "><p id="EN-US_TOPIC_0020212668__p1182723161913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.34653465346535%" headers="mcps1.3.7.2.1.4.1.3 "><p id="EN-US_TOPIC_0020212668__p79774531157"><strong id="EN-US_TOPIC_0020212668__b2046415441812">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p12827133121914">Specifies the returned job ID after delivering the job. You can query the job progress using this ID. For details about how to query the job execution status based on <strong id="EN-US_TOPIC_0020212668__b176813401213">job_id</strong>, see <a href="en-us_topic_0022225397.html">Job Status Management</a>.</p>
|
|
<p id="EN-US_TOPIC_0020212668__p10609556134619"><strong id="EN-US_TOPIC_0020212668__b1763741011919">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p8453833853">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020212668__row582720317197"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.7.2.1.4.1.1 "><p id="EN-US_TOPIC_0020212668__p282873131918">serverIds</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.7.2.1.4.1.2 "><p id="EN-US_TOPIC_0020212668__p1582818371912">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.34653465346535%" headers="mcps1.3.7.2.1.4.1.3 "><p id="EN-US_TOPIC_0020212668__p03951371662"><strong id="EN-US_TOPIC_0020212668__b1146585419184">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p14666221162912">Specifies <span id="EN-US_TOPIC_0020212668__text18205645182215">ECS</span> IDs.</p>
|
|
<div class="note" id="EN-US_TOPIC_0020212668__note752092412290"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020212668__p1878139172911">You can query <span id="EN-US_TOPIC_0020212668__text1094994672212">ECS</span> details by <span id="EN-US_TOPIC_0020212668__text4592139163513">ECS</span> ID. If the system returns a 404 error, the <span id="EN-US_TOPIC_0020212668__text1949264493515">ECS</span> is being created, or creating the <span id="EN-US_TOPIC_0020212668__text18149492357">ECS</span> failed.</p>
|
|
</div></div>
|
|
<p id="EN-US_TOPIC_0020212668__p19611191112470"><strong id="EN-US_TOPIC_0020212668__b14638121071919">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0020212668__p1413619501151">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0020212668__p930619377222">For details about abnormal responses, see <a href="en-us_topic_0022067714.html">Responses (Jobs)</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section755512111436"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0020212668__ul6110122211309"><li id="EN-US_TOPIC_0020212668__li191181837123013">Create a pay-per-use ECS with 2 vCPUs, 16 GiB of memory, private image <strong id="EN-US_TOPIC_0020212668__b10398179493">imageid_123</strong>, SSD disks attached, and 10 Mbit/s of bandwidth-billed EIP bound. Use the key pair for login authentication.<pre class="screen" id="EN-US_TOPIC_0020212668__screen0770128355">POST https://<em id="EN-US_TOPIC_0020212668__i915863815613">{endpoint}</em>/v1/{project_id}/cloudservers
|
|
|
|
{
|
|
"server": {
|
|
"availability_zone":"az1-dc1",
|
|
"name": "newserver",
|
|
"imageRef": "imageid_123",
|
|
"root_volume": {
|
|
"volumetype": "SSD"
|
|
},
|
|
"data_volumes": [
|
|
{
|
|
"volumetype": "SSD",
|
|
"size": 100
|
|
},
|
|
{
|
|
"volumetype": "SSD",
|
|
"size": 100,
|
|
"multiattach": true,
|
|
"hw:passthrough": true
|
|
}
|
|
],
|
|
"flavorRef": "m3.large.8",
|
|
"vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171",
|
|
"security_groups": [
|
|
{
|
|
"id": "507ca48f-814c-4293-8706-300564d54620"
|
|
}
|
|
],
|
|
"nics": [
|
|
{
|
|
"subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83",
|
|
"extra_dhcp_opts":[
|
|
{
|
|
"opt_value": 8888,
|
|
"opt_name": "26"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"publicip": {
|
|
"eip": {
|
|
"iptype": "5_bgp",
|
|
"bandwidth": {
|
|
"size": 10,
|
|
"sharetype": "PER"
|
|
}
|
|
}
|
|
},
|
|
"key_name": "sshkey-123",
|
|
"count": 1
|
|
}
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0020212668__li53019517307">Use a full-ECS image with an encrypted system disk and two data disks to create an <span id="EN-US_TOPIC_0020212668__text107141133142">ECS</span>. For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GiB. Also, attach a 50 GiB SSD disk to the <span id="EN-US_TOPIC_0020212668__text11295122820158">ECS</span>.<pre class="screen" id="EN-US_TOPIC_0020212668__screen13269424193610">POST https://<em id="EN-US_TOPIC_0020212668__i775594685614">{endpoint}</em>/v1/{project_id}/cloudservers
|
|
|
|
{
|
|
"server": {
|
|
"availability_zone":"az1-dc1",
|
|
"name": "wholeImageServer",
|
|
"imageRef": "ff49b1f1-3e3e-4913-89c6-a026041661e8",
|
|
"root_volume": {
|
|
"volumetype": "SSD",
|
|
"metadata": {
|
|
"__system__encrypted": "1",
|
|
"__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846"
|
|
}
|
|
},
|
|
"data_volumes": [
|
|
{
|
|
"volumetype": "SSD",
|
|
"size": 100,
|
|
"extendparam":{
|
|
"snapshotId": "ef020653-9742-4d24-8672-10af42c9702b"
|
|
}
|
|
},
|
|
{
|
|
"volumetype": "SSD",
|
|
"size": 50
|
|
}
|
|
],
|
|
"flavorRef": "s2.large.2",
|
|
"vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171",
|
|
"security_groups": [
|
|
{
|
|
"id": "507ca48f-814c-4293-8706-300564d54620"
|
|
}
|
|
],
|
|
"nics": [
|
|
{
|
|
"subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83"
|
|
}
|
|
],
|
|
"key_name": "sshkey-123"
|
|
}
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0020212668__li8526148115111">Send a pre-verification request to check whether mandatory parameters are configured in the request and whether the request format is correct.<pre class="screen" id="EN-US_TOPIC_0020212668__screen46185445414">POST https://<em id="EN-US_TOPIC_0020212668__i12590155731818">{endpoint}</em>/v1/{project_id}/cloudservers
|
|
|
|
{
|
|
"dry_run": true,
|
|
"server": {
|
|
"availability_zone":"az1-dc1",
|
|
"name": "newserver",
|
|
"imageRef": "1189efbf-d48b-46ad-a823-94b942e2a000",
|
|
"root_volume": {
|
|
"volumetype": "SSD"
|
|
},
|
|
"data_volumes": [
|
|
{
|
|
"volumetype": "SSD",
|
|
"size": 100,
|
|
"multiattach": true,
|
|
"hw:passthrough": true
|
|
}
|
|
],
|
|
"flavorRef": "s3.xlarge.2",
|
|
"vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171",
|
|
"security_groups": [
|
|
{
|
|
"id": "507ca48f-814c-4293-8706-300564d54620"
|
|
}
|
|
],
|
|
"nics": [
|
|
{
|
|
"subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83"
|
|
}
|
|
],
|
|
"key_name": "sshkey-123",
|
|
"count": 1
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section584343712331"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0020212668__screen1429774910412">{
|
|
"job_id": "ff808082739334d80173941567f21d4f",
|
|
"serverIds": [
|
|
"118258c5-0c6a-4e73-8b51-8d1ea3272e1b"
|
|
]
|
|
}</pre>
|
|
<p id="EN-US_TOPIC_0020212668__p633417471729">Or</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0020212668__screen1391512577212">{
|
|
"error": {
|
|
"code": "request body is illegal.",
|
|
"message": "Ecs.0005"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section3394154515224"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212668__p11579229172415">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020212668__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020212668__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_0020212657.html">Lifecycle Management</a></div>
|
|
</div>
|
|
</div>
|
|
|