forked from docs/doc-exports
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
872 lines
92 KiB
HTML
872 lines
92 KiB
HTML
<a name="EN-US_TOPIC_0106040941"></a><a name="EN-US_TOPIC_0106040941"></a>
|
||
|
||
<h1 class="topictitle1">Creating <span id="text8992548111218">BMS</span><span id="text15803221423"></span><span id="text205161451161216"></span>s</h1>
|
||
<div id="body1523429204540"><div class="section" id="EN-US_TOPIC_0106040941__section61091410172310"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0106040941__p791813352114">This API is used to create one or more <span id="EN-US_TOPIC_0106040941__text14806191721313">BMS</span><span id="EN-US_TOPIC_0106040941__text1780614171137"></span>s.</p>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section17809913014"><h4 class="sectiontitle">Background for Setting the Login Authentication Mode</h4><p id="EN-US_TOPIC_0106040941__p599644618118">Logging in to a BMS 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_0106040941__en-us_topic_0013859510_ul48963016215158"><li id="EN-US_TOPIC_0106040941__en-us_topic_0013859510_li38304700215158">Key pair<p id="EN-US_TOPIC_0106040941__en-us_topic_0013859510_p37613652183921"><a name="EN-US_TOPIC_0106040941__en-us_topic_0013859510_li38304700215158"></a><a name="en-us_topic_0013859510_li38304700215158"></a>A key pair is used for BMS login authentication.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p240161911714">Method of calling APIs: Use the <strong id="EN-US_TOPIC_0106040941__b1332508762102749">key_name</strong> field to specify the key file used for logging in to the BMS. For details about how to use the <strong id="EN-US_TOPIC_0106040941__b145221982215">key_name</strong> field, see <a href="#EN-US_TOPIC_0106040941__table114451828162019">Table 2</a>.</p>
|
||
</li><li id="EN-US_TOPIC_0106040941__en-us_topic_0013859510_li64799030183852">Password<p id="EN-US_TOPIC_0106040941__en-us_topic_0013859510_p6641315318409"><a name="EN-US_TOPIC_0106040941__en-us_topic_0013859510_li64799030183852"></a><a name="en-us_topic_0013859510_li64799030183852"></a>If you choose the initial password for authentication in a BMS, you can log in to a BMS using the username and its initial password. The initial password of user <strong id="EN-US_TOPIC_0106040941__b1983815851320">root</strong> is used for authentication in Linux.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p115739361915">Methods of calling APIs:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul3218134018335"><li id="EN-US_TOPIC_0106040941__li189621732163318">Method 1 (recommended): Use the <strong id="EN-US_TOPIC_0106040941__b2023291927103540">adminPass</strong> field to specify the initial login password of the specified administrator account. For details about how to use the <strong id="EN-US_TOPIC_0106040941__b673147730104123">adminPass</strong> field, see <a href="#EN-US_TOPIC_0106040941__table114451828162019">Table 2</a>.<div class="note" id="EN-US_TOPIC_0106040941__note481424942414"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p1081594982420">For Linux BMSs with Cloud-Init, if field <strong id="EN-US_TOPIC_0106040941__b053810357147">user_data</strong> is specified, field <strong id="EN-US_TOPIC_0106040941__b3538735101411">adminPass</strong> is invalid.</p>
|
||
</div></div>
|
||
</li><li id="EN-US_TOPIC_0106040941__li124519337338">Method 2:<ul id="EN-US_TOPIC_0106040941__ul152271153103313"><li id="EN-US_TOPIC_0106040941__li173831751163316">For Linux BMSs with Cloud-Init, use the <strong id="EN-US_TOPIC_0106040941__b1150976838104611">user_data</strong> field to inject data. For details, see <a href="#EN-US_TOPIC_0106040941__table114451828162019">Table 2</a>.</li></ul>
|
||
</li></ul>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note6149111002018"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p12149141010209">Public images contain Cloud-Init or Cloudbase-Init by default. For private images, you need to check whether Cloud-Init or Cloudbase-Init is installed.</p>
|
||
</div></div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section14953166171212"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0106040941__ul829487989"><li id="EN-US_TOPIC_0106040941__li112941372819">File injection is not supported.</li></ul>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section20581142651215">
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section1489343491410"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0106040941__p458655125711">POST /v1/{project_id}/baremetalservers</p>
|
||
<p id="EN-US_TOPIC_0106040941__p234017122593"><a href="#EN-US_TOPIC_0106040941__table1878518571">Table 1</a> lists the parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table1878518571"></a><a name="table1878518571"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table1878518571" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row178875118576"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0106040941__p43085863">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.2"><p id="EN-US_TOPIC_0106040941__p294000">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.3"><p id="EN-US_TOPIC_0106040941__p23814038">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row88819514575"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p14468758">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p31118786">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p37593705">Specifies the project ID.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p1775157103720">For details about how to obtain the project ID, see <a href="en-us_topic_0171277624.html">Obtaining a Project ID</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section77721535171710"><h4 class="sectiontitle">Request Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table5655102511816" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0106040941__row865513258181"><th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.6.2.1.5.1.1"><p id="EN-US_TOPIC_0106040941__p465513251182">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.2.1.5.1.2"><p id="EN-US_TOPIC_0106040941__p12229531161811">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.2.1.5.1.3"><p id="EN-US_TOPIC_0106040941__p10655152521813">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.6.2.1.5.1.4"><p id="EN-US_TOPIC_0106040941__p2655172551815">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row1655925181813"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.2.1.5.1.1 "><p id="EN-US_TOPIC_0106040941__p11655102531815">server</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.2.1.5.1.2 "><p id="EN-US_TOPIC_0106040941__p1165517255186">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.2.1.5.1.3 "><p id="EN-US_TOPIC_0106040941__p12656142551819">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.2.1.5.1.4 "><p id="EN-US_TOPIC_0106040941__p3656152516182">Specifies <span id="EN-US_TOPIC_0106040941__text28174124229">BMS</span><span id="EN-US_TOPIC_0106040941__text178171124229"></span> information. For details, see <a href="#EN-US_TOPIC_0106040941__table114451828162019">Table 2</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table114451828162019"></a><a name="table114451828162019"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table114451828162019" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0106040941__b1121625216593">server</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row14447328122011"><th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.6.3.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p1396818541127">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.3.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p8975105411213">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.3.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p6985185414129">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.6.3.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p69991654141210">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row12447132817206"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p10447152818203">imageRef</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p6447928172019">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p844742815204">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p12447428182018">Specifies the image ID or image resource URL used for creating the <span id="EN-US_TOPIC_0106040941__text3726141613223">BMS</span><span id="EN-US_TOPIC_0106040941__text1872651612226"></span>. The ID is in the format of a Universally Unique Identifier (UUID).</p>
|
||
<p id="EN-US_TOPIC_0106040941__p131041058184113">You can obtain the image ID from the IMS console or by following the instructions in "Querying Images" in <em id="EN-US_TOPIC_0106040941__i891632372020">Image Management Service API Reference</em>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p2034515473316">When using an API to query images, you can add the field <strong id="EN-US_TOPIC_0106040941__b9930626112312">?virtual_env_type=Ironic</strong> to filter <span id="EN-US_TOPIC_0106040941__text08001627132220">BMS</span><span id="EN-US_TOPIC_0106040941__text8800427112218"></span> images.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row194477285202"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p17447172813201">flavorRef</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p154472287207">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p17447142813203">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p467332272212">Specifies the flavor ID of the <span id="EN-US_TOPIC_0106040941__text117561430192218">BMS</span><span id="EN-US_TOPIC_0106040941__text6756163018223"></span>. The format is <strong id="EN-US_TOPIC_0106040941__b3591103913444">physical.</strong><em id="EN-US_TOPIC_0106040941__i1869324811445">x</em><strong id="EN-US_TOPIC_0106040941__b022635318446">.</strong><em id="EN-US_TOPIC_0106040941__i84622057114414">x</em>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p11950518194411">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0106040941__text7956135112214">BMS</span><span id="EN-US_TOPIC_0106040941__text49561035152220"></span> console or using the <a href="en-us_topic_0131326852.html">Querying Details About Flavors and Extended Flavor Information</a> API.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row8447132815202"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1444717282209">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p8481738172110">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p12447228112018">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p6589115412241">Specifies the <span id="EN-US_TOPIC_0106040941__text141115463223">BMS</span><span id="EN-US_TOPIC_0106040941__text124111446182219"></span> name.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p205901254132419">Value range:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul115905548245"><li id="EN-US_TOPIC_0106040941__li467912154411">The value can contain a maximum of 63 characters consisting of letters (case-insensitive), digits, underscores (_), hyphens (-), and periods (.).</li><li id="EN-US_TOPIC_0106040941__li205901454102415">If more than one <span id="EN-US_TOPIC_0106040941__text1183394942216">BMS</span><span id="EN-US_TOPIC_0106040941__text8833124972220"></span> is to be created, tags similar to <strong id="EN-US_TOPIC_0106040941__b842352706144049">-0000</strong> will be automatically added to the end of the <span id="EN-US_TOPIC_0106040941__text101132053132210">BMS</span><span id="EN-US_TOPIC_0106040941__text1611315312229"></span> names during the creation. In this case, the BMS name contains 1 to 58 characters.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row13447228112013"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1744719286208">metadata</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p184471128202017">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p7447172819209">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p844782817203">Specifies the <span id="EN-US_TOPIC_0106040941__text193244572227">BMS</span><span id="EN-US_TOPIC_0106040941__text10324125732217"></span> metadata. The maximum size for both the metadata <strong id="EN-US_TOPIC_0106040941__b457632432215">key</strong> and <strong id="EN-US_TOPIC_0106040941__b98841527112215">value</strong> is 255 characters. For details, see <a href="#EN-US_TOPIC_0106040941__table187761842111012">Table 3</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row1544742822014"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p9447228142010">user_data</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p174474283209">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p244710285203">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1833613141211">Specifies the user data to be injected during the <span id="EN-US_TOPIC_0106040941__text11721010235">BMS</span><span id="EN-US_TOPIC_0106040941__text1726082313"></span> creation. Text can be injected.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p17612915683">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul261216151782"><li id="EN-US_TOPIC_0106040941__li2612191515813">The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.</li><li id="EN-US_TOPIC_0106040941__li06129151384">If <strong id="EN-US_TOPIC_0106040941__b3322648805">key_name</strong> is not specified, the password of user <strong id="EN-US_TOPIC_0106040941__b03226484013">root</strong> for logging in to the <span id="EN-US_TOPIC_0106040941__text10915442235">BMS</span><span id="EN-US_TOPIC_0106040941__text1915647231"></span> will be injected by default.</li></ul>
|
||
<p id="EN-US_TOPIC_0106040941__p156126154810">Password complexity requirements:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul13612715685"><li id="EN-US_TOPIC_0106040941__li0612151512820">Contains 8 to 26 characters.</li><li id="EN-US_TOPIC_0106040941__li136124156810">Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?</li></ul>
|
||
<p id="EN-US_TOPIC_0106040941__p561215151820">An example is as follows:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul15612615889"><li id="EN-US_TOPIC_0106040941__li146121115887">Use a plaintext password (risky in security), for example, <strong id="EN-US_TOPIC_0106040941__b1345964216117">cloud.1234</strong>.<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0106040941__screen1961214151287"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">#</span><span class="o">!/</span><span class="n">bin</span><span class="o">/</span><span class="n">bash</span><span class="w"> </span>
|
||
<span class="n">echo</span><span class="w"> </span><span class="err">'</span><span class="n">root</span><span class="p">:</span><span class="n">Cloud</span><span class="mf">.1234</span><span class="err">'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">chpasswd</span><span class="w"> </span><span class="p">;</span>
|
||
</pre></div></td></tr></table></div>
|
||
|
||
</div>
|
||
</li><li id="EN-US_TOPIC_0106040941__li15971145084012">Use a password.<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0106040941__screen126121153810"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">#</span><span class="o">!/</span><span class="n">bin</span><span class="o">/</span><span class="n">bash</span><span class="w"> </span>
|
||
<span class="n">echo</span><span class="w"> </span><span class="err">'</span><span class="n">root</span><span class="p">:</span><span class="n">$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig</span><span class="err">'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">chpasswd</span><span class="w"> </span><span class="o">-</span><span class="n">e</span>
|
||
</pre></div></td></tr></table></div>
|
||
|
||
</div>
|
||
</li></ul>
|
||
<p id="EN-US_TOPIC_0106040941__p206121151288">where, <strong id="EN-US_TOPIC_0106040941__b2030011547116">$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig</strong> is the ciphertext password, which can be generated as follows:</p>
|
||
<ol id="EN-US_TOPIC_0106040941__ol186121815882"><li id="EN-US_TOPIC_0106040941__li1461312151784">Generate an encrypted salt value.<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0106040941__screen3613215481"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="o">[</span><span class="n">root</span><span class="nd">@test</span><span class="w"> </span><span class="n">linux</span><span class="o">]</span><span class="err">#</span><span class="w"> </span><span class="n">python</span><span class="w"> </span><span class="o">-</span><span class="n">c</span><span class="w"> </span><span class="s">"import crypt, getpass, pwd;print crypt.mksalt()"</span><span class="w"> </span>
|
||
<span class="n">$6$V6azyeLwcD3CHlpY</span>
|
||
</pre></div></td></tr></table></div>
|
||
|
||
</div>
|
||
</li><li id="EN-US_TOPIC_0106040941__li911475973910">Generate a ciphertext password based on the salt value.<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0106040941__screen99357473910"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="o">[</span><span class="n">root</span><span class="nd">@test</span><span class="w"> </span><span class="n">linux</span><span class="o">]</span><span class="err">#</span><span class="w"> </span><span class="n">python</span><span class="w"> </span><span class="o">-</span><span class="n">c</span><span class="w"> </span><span class="s">"import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')"</span><span class="w"> </span>
|
||
<span class="w"> </span><span class="n">$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig</span>
|
||
</pre></div></td></tr></table></div>
|
||
|
||
</div>
|
||
</li></ol>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note16909121093617"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p89091410153619">Data injection is not supported for <span id="EN-US_TOPIC_0106040941__text13144192302318">BMS</span><span id="EN-US_TOPIC_0106040941__text191441823152316"></span>s that use a Linux image and the password login mode. </p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row870216216471"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p12705182174711">adminPass</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p370516210478">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p6705112184714">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p12995174416219">Specifies the initial login password of the administrator account for logging in to a <span id="EN-US_TOPIC_0106040941__text0874912113714">BMS</span><span id="EN-US_TOPIC_0106040941__text1987418127374"></span> using password authentication. The Linux administrator is <strong id="EN-US_TOPIC_0106040941__b1583121903510">root</strong>.</p>
|
||
<div class="p" id="EN-US_TOPIC_0106040941__p578131415383">Password complexity requirements:<ul id="EN-US_TOPIC_0106040941__ul52104519219"><li id="EN-US_TOPIC_0106040941__li1025452217">Contains 8 to 26 characters.</li><li id="EN-US_TOPIC_0106040941__li142114510215">Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?</li><li id="EN-US_TOPIC_0106040941__li15244511217">(Linux OSs) Cannot contain the username or the username in reverse.</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row71112509352"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p0127500354">key_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p1312450203518">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p2121950193514">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p183831662478">Specifies the name of a key pair. This is an extended attribute. To log in to a <span id="EN-US_TOPIC_0106040941__text681273122316">BMS</span> using an SSH key pair, set the value to the name of an existing private key.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p2721134615450">You can create a key pair using the <a href="en-us_topic_0060384660.html">Creating and Importing an SSH Key Pair (Native OpenStack API)</a> API, or query existing key pairs using the <a href="en-us_topic_0060384658.html">Querying SSH Key Pairs (Native OpenStack API)</a> API.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p121011469384">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul81019468382"><li id="EN-US_TOPIC_0106040941__li176396585388">If both <strong id="EN-US_TOPIC_0106040941__b84235270616385">key_name</strong> and <strong id="EN-US_TOPIC_0106040941__b84235270616388">user_data</strong> are specified, <strong id="EN-US_TOPIC_0106040941__b1204886164163819">user_data</strong> only injects user data.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row65832537352"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p185841053203511">security_groups</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p12584453193520">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p8584105311356">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p2043719831610">Specifies security groups of the <span id="EN-US_TOPIC_0106040941__text19342134872315">BMS</span><span id="EN-US_TOPIC_0106040941__text5342848202310"></span>. For details, see <a href="#EN-US_TOPIC_0106040941__table3900132719153">Table 4</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row724105716351"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p12411257193510">nics</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p1724165773514">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p324155712352">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p7627161794014">Specifies NICs of the <span id="EN-US_TOPIC_0106040941__text112698527237">BMS</span><span id="EN-US_TOPIC_0106040941__text142691752172319"></span>. For details, see <a href="#EN-US_TOPIC_0106040941__table117050392164">Table 5</a>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p9262122313405">Constraints:</p>
|
||
<p id="EN-US_TOPIC_0106040941__p9423204213412">A maximum of two NICs can be attached to a <span id="EN-US_TOPIC_0106040941__text1520695552310">BMS</span><span id="EN-US_TOPIC_0106040941__text520605516231"></span>. The first will be used as the primary NIC. If multiple NICs are specified, ensure that all NICs belong to the same VPC.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row191911053617"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p17191130123619">availability_zone</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p201911809368">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p619115003614">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1519240183614">Specifies the name of the AZ where the <span id="EN-US_TOPIC_0106040941__text11767972245">BMS</span><span id="EN-US_TOPIC_0106040941__text16767375245"></span> is located.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row975216303612"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p177522343619">vpcid</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p675220320364">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p47520323613">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p87520319362">Specifies the ID of the VPC to which the <span id="EN-US_TOPIC_0106040941__text2951171515256">BMS</span><span id="EN-US_TOPIC_0106040941__text495191517256"></span> belongs. The value is in UUID format. You can obtain the VPC ID from the network console or by following the instructions in "Querying VPC Details" of <em id="EN-US_TOPIC_0106040941__i177059565415">Virtual Private Cloud API</em><em id="EN-US_TOPIC_0106040941__i670675614413"> Reference</em>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row194066143428"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1040620148426">publicip</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p164061014174213">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p5406131417424">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p20682856174214">Specifies the EIP information of the <span id="EN-US_TOPIC_0106040941__text1843562252515">BMS</span><span id="EN-US_TOPIC_0106040941__text3435122172511"></span>. Possible values include:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul168216564422"><li id="EN-US_TOPIC_0106040941__li1568265618427"><strong id="EN-US_TOPIC_0106040941__b193821428141215">Do not use</strong> (This parameter is unavailable.)</li><li id="EN-US_TOPIC_0106040941__li46309411433"><strong id="EN-US_TOPIC_0106040941__b10164173152117">Automatically assign</strong>: Assign a new EIP.</li><li id="EN-US_TOPIC_0106040941__li9682856134218"><strong id="EN-US_TOPIC_0106040941__b1723834941619">Specify</strong>: Specify an EIP that has been created.</li></ul>
|
||
<p id="EN-US_TOPIC_0106040941__p988135192011">For details, see <a href="#EN-US_TOPIC_0106040941__table5440825153610">Table 6</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row2548151711424"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p205480177425">count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p13548817204215">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p12548817154214">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p247452464619">Specifies the number of <span id="EN-US_TOPIC_0106040941__text8436182712514">BMS</span><span id="EN-US_TOPIC_0106040941__text4436122742511"></span>s to be created.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p49598141173828">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul43730085173828"><li id="EN-US_TOPIC_0106040941__li58026446173828">If this parameter is not specified, the default value is <strong id="EN-US_TOPIC_0106040941__b842352706165622">1</strong>.</li><li id="EN-US_TOPIC_0106040941__li13881548154712">If the quota is sufficient, the maximum value is <strong id="EN-US_TOPIC_0106040941__b399164372214"></strong><strong id="EN-US_TOPIC_0106040941__b7991043192215">24</strong>.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row2740920144217"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1274082016423">root_volume</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p127401203425">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p987415561495">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p4740120104210">Specifies system disk configurations of the <span id="EN-US_TOPIC_0106040941__text211203018259">BMS</span><span id="EN-US_TOPIC_0106040941__text201114301257"></span>. For details, see <a href="#EN-US_TOPIC_0106040941__table338522873815">Table 7</a>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p16667200182418">Constraints:</p>
|
||
<p id="EN-US_TOPIC_0106040941__p149755511196">If the flavor supports quick provisioning, this parameter is mandatory. Otherwise, this parameter is not required. For how to check whether a flavor supports quick provisioning, see <a href="en-us_topic_0114885743.html">Querying Details About extra_specs Parameters of a BMS Flavor (Native OpenStack API)</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row18607172310428"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p16607423184211">data_volumes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p18607132324218">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p94321357104911">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p19300107125018">Specifies data disk configurations of the <span id="EN-US_TOPIC_0106040941__text3707635182515">BMS</span><span id="EN-US_TOPIC_0106040941__text16707133510253"></span>. Each data structure represents a data disk to be created. For details, see <a href="#EN-US_TOPIC_0106040941__table16541153834413">Table 8</a>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p1630019710504">Constraints:</p>
|
||
<p id="EN-US_TOPIC_0106040941__p6554115142519">A maximum of 40 EVS disks (including the system disk and data disks) can be attached to a <span id="EN-US_TOPIC_0106040941__text8662112821020">BMS</span><span id="EN-US_TOPIC_0106040941__text166212285105"></span>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row78434565482"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p28434560482">extendparam</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p784318564484">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p7956105764916">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p10843656134810">Specifies the supplementary for creating the <span id="EN-US_TOPIC_0106040941__text6856741192510">BMS</span><span id="EN-US_TOPIC_0106040941__text685654162518"></span>. For details, see <a href="#EN-US_TOPIC_0106040941__table12971921194613">Table 9</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row68451959154811"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p784513596487">schedulerHints</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p98452596486">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p154118582497">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p16259192320537">Specifies scheduling information of the <span id="EN-US_TOPIC_0106040941__text519944414252">BMS</span><span id="EN-US_TOPIC_0106040941__text11991944152513"></span>. This parameter is mandatory for creating a <span id="EN-US_TOPIC_0106040941__text113781550172512">BMS</span><span id="EN-US_TOPIC_0106040941__text1837845018258"></span> in a DeC.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p208451594481">For details, see <a href="#EN-US_TOPIC_0106040941__table615418218465">Table 10</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row484992120217"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.3.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p111242520210">server_tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p14121525102116">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p7126255217">Map<String,String></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.6.3.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p11124259215">Specifies tags of the <span id="EN-US_TOPIC_0106040941__text1060713446192">BMS</span><span id="EN-US_TOPIC_0106040941__text92716518198"></span>.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul91212252211"><li id="EN-US_TOPIC_0106040941__li41212552116">Key: A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. The tag key of a BMS must be unique. It cannot contain ASCII characters (0–31) or special characters =*<>\,|/</li><li id="EN-US_TOPIC_0106040941__li1512152519216">Value: A tag value contains a maximum of 43 Unicode characters and can be left blank. It cannot contain ASCII characters (0–31) or special characters =*<>\,|/</li></ul>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note146001124202119"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p4460718172214">A maximum of 10 tags can be added to a <span id="EN-US_TOPIC_0106040941__text1946091812220">BMS</span><span id="EN-US_TOPIC_0106040941__text54601518122210"></span>. <strong id="EN-US_TOPIC_0106040941__b1888700206">__type_baremetal</strong> is an internal tag of the system. Therefore, you can add a maximum of nine tags.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table187761842111012"></a><a name="table187761842111012"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table187761842111012" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0106040941__b598822363419">metadata</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row16776542101012"><th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.6.4.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p1789715214134">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.6.4.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p99069217134">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.4.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p1991732171311">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="58.415841584158414%" id="mcps1.3.6.4.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p1926182111135">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row147761242121019"><td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1777194211103">op_svc_userid</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p117772042201015">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p6777144218109">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p160311367116">Specifies the user ID. You can obtain the user ID from <strong id="EN-US_TOPIC_0106040941__b84235270615028">My Credential</strong> on the management console.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row48059375219"><td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1580693711216">BYOL</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p15806137127">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p1680673718212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p3806113712218">Specifies whether a license is provided. The value can be <strong id="EN-US_TOPIC_0106040941__b14573281582">true</strong> or <strong id="EN-US_TOPIC_0106040941__b178219111682">false</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row1777713425107"><td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p13777144201012">admin_pass</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p1077724218101">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p177710429101">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p2040873022212">Specifies the initial password of the administrator account for logging in to a <span id="EN-US_TOPIC_0106040941__text1948314319233">BMS</span><span id="EN-US_TOPIC_0106040941__text8483131152317"></span>. For Linux, the administrator account is <strong id="EN-US_TOPIC_0106040941__b837917409257">root</strong>.</p>
|
||
<div class="p" id="EN-US_TOPIC_0106040941__p165773574518">Password complexity requirements:<ul id="EN-US_TOPIC_0106040941__ul1357716570513"><li id="EN-US_TOPIC_0106040941__li1257725755114">Contains 8 to 26 characters.</li><li id="EN-US_TOPIC_0106040941__li12577175718518">Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?</li><li id="EN-US_TOPIC_0106040941__li857715575519">Cannot contain the username, the username in reverse, or more than two consecutive characters in the username.</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row1763891584915"><td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.6.4.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p11682137191114">agency_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.4.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p16821437201116">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p4682193751112">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="58.415841584158414%" headers="mcps1.3.6.4.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1895873421317">Specifies the IAM agency name.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p9838135643413">An agency provides a temporary security credential for accessing a <span id="EN-US_TOPIC_0106040941__text81265192710">BMS</span><span id="EN-US_TOPIC_0106040941__text11121155274"></span>. The agency is created by the tenant administrator on the IAM console.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table3900132719153"></a><a name="table3900132719153"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table3900132719153" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0106040941__b153361940173717">security_groups</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row9901927171518"><th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.6.5.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p2683143141318">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.5.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p769543151317">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.5.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p2703113121317">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.6.5.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p77111831171318">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row390112275151"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.6.5.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p139011427161514">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.5.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p490122761517">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.5.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p29019273159">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.6.5.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1890162741513">Specifies the security group ID, which takes effect for all NICs configured for the <span id="EN-US_TOPIC_0106040941__text1214817132715">BMS</span><span id="EN-US_TOPIC_0106040941__text1221401772713"></span>.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul3918152155712"><li id="EN-US_TOPIC_0106040941__li11918524574">If this parameter is not specified, the default security group will be bound to the <span id="EN-US_TOPIC_0106040941__text169162042716">BMS</span><span id="EN-US_TOPIC_0106040941__text36916202273"></span>.</li><li id="EN-US_TOPIC_0106040941__li1985895345718">If this parameter is required (in UUID format), use the ID of an existing security group. For details about how to obtain existing security groups, see "Querying Security Groups" in <em id="EN-US_TOPIC_0106040941__i104607348115">Virtual Private Cloud </em><em id="EN-US_TOPIC_0106040941__i10460183414118">API</em><em id="EN-US_TOPIC_0106040941__i346012349116"></em><em id="EN-US_TOPIC_0106040941__i134611834201111"> Reference</em>.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table117050392164"></a><a name="table117050392164"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table117050392164" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0106040941__b7360105743812">nics</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row47051439181616"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.6.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p17321183512138">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.6.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p123311335161319">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.6.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p1733918359133">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.6.6.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p14348183591317">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row147053391169"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p27051439151614">subnet_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p177051839171620">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p11705153921617">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p33641624111714">Specifies the subnet information of a <span id="EN-US_TOPIC_0106040941__text10916226192710">BMS</span><span id="EN-US_TOPIC_0106040941__text891632618274"></span> NIC.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p19364202491713">The value must be the ID of the subnet (<strong id="EN-US_TOPIC_0106040941__b7522201113383">network_id</strong>) created in the VPC specified by <strong id="EN-US_TOPIC_0106040941__b84235270617196">vpcid</strong> and in the format of UUID. You can obtain the subnet ID (<strong id="EN-US_TOPIC_0106040941__b04111836201315">network_id</strong>) from the VPC console or by following the instructions in "Querying Subnets" in <em id="EN-US_TOPIC_0106040941__i164131836101311">Virtual Private Cloud API Reference</em>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row16103185713112"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p147811512174016">port_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p8782812134011">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p157829121405">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p17829129401">Specifies the <span id="EN-US_TOPIC_0106040941__text15105112493711">BMS</span><span id="EN-US_TOPIC_0106040941__text22041729193719"></span> NIC ID. If this parameter is not left blank, a NIC is specified. In this case, <strong id="EN-US_TOPIC_0106040941__b162438313133">subnet_id</strong>, <strong id="EN-US_TOPIC_0106040941__b212811711315">security_groups</strong>, <strong id="EN-US_TOPIC_0106040941__b29562106138">ip_address</strong>, <strong id="EN-US_TOPIC_0106040941__b1242941481317">ipv6_enable</strong>, and <strong id="EN-US_TOPIC_0106040941__b8903192214137">ipv6_bandwidth</strong> are invalid.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p89194747">You can obtain the NIC ID from the VPC console or by following the instructions in "Querying Ports" in <em id="EN-US_TOPIC_0106040941__i169412172155">Virtual Private Cloud API Reference</em>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p348619121161">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul67808241262"><li id="EN-US_TOPIC_0106040941__li725925013615">The NIC must be in <strong id="EN-US_TOPIC_0106040941__b125932843915">DOWN</strong> state.</li><li id="EN-US_TOPIC_0106040941__li155117111877">The VPC ID of the NIC must match the VPC of the <span id="EN-US_TOPIC_0106040941__text178326514375">BMS</span><span id="EN-US_TOPIC_0106040941__text13109958183717"></span>.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row8705193981611"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p570553941615">ip_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p107052039151618">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.6.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p670583941612">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.6.6.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p197051239171616">Specifies the IPv4 address of a <span id="EN-US_TOPIC_0106040941__text19698322273">BMS</span><span id="EN-US_TOPIC_0106040941__text15969132102712"></span> NIC.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p350820571815">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul15081653180"><li id="EN-US_TOPIC_0106040941__li6986101551812">If this parameter is left blank or set to <strong id="EN-US_TOPIC_0106040941__b842352706173944">""</strong>, an unused IP address in the subnet of this network is automatically assigned as the IP address of the NIC.</li><li id="EN-US_TOPIC_0106040941__li2085313109184">If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.</li><li id="EN-US_TOPIC_0106040941__li28494501168">The IP address cannot be specified when you create <span id="EN-US_TOPIC_0106040941__text17392133682715">BMS</span><span id="EN-US_TOPIC_0106040941__text143922036192716"></span>s in a batch.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table5440825153610"></a><a name="table5440825153610"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table5440825153610" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0106040941__b1251124811536">publicip</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row74421925193612"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.7.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p15425049151">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.6.7.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p1843416451514">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.7.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p244224111519">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.6.7.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p1945416481515">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row24426257367"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p34423256365">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p8442132543618">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p944202543615">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p448642293710">Specifies the ID of an existing EIP assigned to the <span id="EN-US_TOPIC_0106040941__text1950135515276">BMS</span><span id="EN-US_TOPIC_0106040941__text99507559278"></span>. The value is in UUID format. You can obtain the EIP ID from the network console or by following the instructions in "Querying EIPs" in <em id="EN-US_TOPIC_0106040941__i7586205471611">Elastic IP API Reference</em>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p0962133173717">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul8422122510912"><li id="EN-US_TOPIC_0106040941__li1242217251492">Only EIPs in the <strong id="EN-US_TOPIC_0106040941__b842352706191445">DOWN</strong> state can be assigned.</li><li id="EN-US_TOPIC_0106040941__li1812519291794">Existing EIPs cannot be used for creating <span id="EN-US_TOPIC_0106040941__text1863112182815">BMS</span><span id="EN-US_TOPIC_0106040941__text146311510282"></span>s in a batch. That is, this parameter is invalid in such a case.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row1344218250366"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p2442025193618">eip</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.6.7.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p194421625123615">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.7.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p744292517368">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.6.7.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1944272519368">Specifies the configuration for creating an EIP that will be automatically assigned to the <span id="EN-US_TOPIC_0106040941__text1271154122813">BMS</span><span id="EN-US_TOPIC_0106040941__text1471104172819"></span>. For details, see <a href="#EN-US_TOPIC_0106040941__table139542215219">Table 11</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note23876648151519"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p13563242151519">You can configure either but not both of <strong id="EN-US_TOPIC_0106040941__b50762782172634">id</strong> and <strong id="EN-US_TOPIC_0106040941__b18144641172634">eip</strong> in the <strong id="EN-US_TOPIC_0106040941__b60429854172634">publicip</strong> field.</p>
|
||
</div></div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table338522873815"></a><a name="table338522873815"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table338522873815" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="EN-US_TOPIC_0106040941__b13145238597">root_volume</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row1385828173818"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.9.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p95201812161513">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.6.9.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p353015121156">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.9.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p18541201271513">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="56.43564356435643%" id="mcps1.3.6.9.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p15551312101516">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row938613285387"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.9.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1638612893814">volumetype</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.9.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p13386528173811">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.9.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p103861828163812">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.9.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p820813316399">Specifies the <span id="EN-US_TOPIC_0106040941__text53680972819">BMS</span><span id="EN-US_TOPIC_0106040941__text43681952816"></span> system disk type. The disk type must match the available disk type.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul820817319391"><li id="EN-US_TOPIC_0106040941__li820812343910">SAS: high I/O disk type</li><li id="EN-US_TOPIC_0106040941__li51009485235">SSD: ultra-high I/O disk type</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row17386162843817"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.9.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p20386162813389">size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.6.9.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p73869285387">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.9.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p173865283388">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.43564356435643%" headers="mcps1.3.6.9.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p6118104603916">Specifies the system disk size (GB). The value ranges from <strong id="EN-US_TOPIC_0106040941__b84235270619177">40</strong> to <strong id="EN-US_TOPIC_0106040941__b842352706191711">1024</strong>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p17118104618392">Constraints:</p>
|
||
<p id="EN-US_TOPIC_0106040941__p46461938191816">The system disk size must be greater than or equal to the minimum system disk size of the image (<strong id="EN-US_TOPIC_0106040941__b842352706191837">min_disk</strong> attribute).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table16541153834413"></a><a name="table16541153834413"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table16541153834413" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="EN-US_TOPIC_0106040941__b1790613716418">data_volumes</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row1669912382442"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.10.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p1279519277155">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.10.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p18087278156">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.10.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p18814172781515">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="55.44554455445545%" id="mcps1.3.6.10.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p13823202711519">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row14699038184412"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p196990382444">volumetype</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p12699738194417">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p769923819449">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.6.10.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p2069917386442">Specifies the <span id="EN-US_TOPIC_0106040941__text56642272304">BMS</span><span id="EN-US_TOPIC_0106040941__text126646271303"></span> data disk type. The disk type must match the available disk type.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul20699938174417"><li id="EN-US_TOPIC_0106040941__li13699838204419">SAS: high I/O disk type</li><li id="EN-US_TOPIC_0106040941__li12699638114416">SSD: ultra-high I/O disk type</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row11699438164410"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1569923814418">size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p11699338104418">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p18699133814413">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.6.10.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p369917385448">Specifies the data disk size (GB). The value ranges from <strong id="EN-US_TOPIC_0106040941__b842352706192054">10</strong> to <strong id="EN-US_TOPIC_0106040941__b842352706192058">32768</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row166991438104414"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p206991138104415">shareable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p86991838124412">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.10.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p10699143814416">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.44554455445545%" headers="mcps1.3.6.10.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p162690539421">Specifies whether the disk is shareable.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul1882017274320"><li id="EN-US_TOPIC_0106040941__li18202254315"><strong id="EN-US_TOPIC_0106040941__b18349144517478">true</strong>: shared EVS disk</li><li id="EN-US_TOPIC_0106040941__li10820221434"><strong id="EN-US_TOPIC_0106040941__b18582359144713">false</strong>: common EVS disk</li></ul>
|
||
<p id="EN-US_TOPIC_0106040941__p1369983824420">The default value is <strong id="EN-US_TOPIC_0106040941__b510174416480">false</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table12971921194613"></a><a name="table12971921194613"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table12971921194613" frame="border" border="1" rules="all"><caption><b>Table 9 </b><strong id="EN-US_TOPIC_0106040941__b1457316161803">extendparam</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row19258182110467"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.11.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p51861045121511">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.11.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p1197245181510">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.11.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p42047453157">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.6.11.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p13213104513159">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row3258102110464"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p12581321124615">chargingMode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p18258021104612">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p325816216461">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.6.11.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p1125852184618">Specifies the billing mode. Value range:</p>
|
||
<p id="EN-US_TOPIC_0106040941__p0894752335"><strong id="EN-US_TOPIC_0106040941__b193320503611">postPaid</strong>: pay-per-use billing</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row1025982134620"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p12593211464">regionID</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p192591021174611">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.11.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p192596216469">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.6.11.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p15259142134617">Specifies the ID of the region where the <span id="EN-US_TOPIC_0106040941__text18491313163116">BMS</span><span id="EN-US_TOPIC_0106040941__text204931314313"></span> resides.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table615418218465"></a><a name="table615418218465"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table615418218465" frame="border" border="1" rules="all"><caption><b>Table 10 </b><strong id="EN-US_TOPIC_0106040941__b4735155918115">schedulerHints</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row826262111464"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.12.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p1114603810168">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.12.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p11153538171616">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.12.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p2161143819168">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.6.12.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p31721938101611">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row626482118461"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.12.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p8264192154613">dec_baremetal</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.12.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p13264102194615">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.12.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p1626432124610">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.6.12.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p951682911395">Specifies whether to create the <span id="EN-US_TOPIC_0106040941__text2330124514319">BMS</span><span id="EN-US_TOPIC_0106040941__text11331545183117"></span> in a DeC. The value can be <strong id="EN-US_TOPIC_0106040941__b342321162210">share</strong> or <strong id="EN-US_TOPIC_0106040941__b58719512220">dedicate</strong>.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p1664352012471">Constraints:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul73891025174712"><li id="EN-US_TOPIC_0106040941__li2465457164913">If this parameter is not specified, the default value is <strong id="EN-US_TOPIC_0106040941__b8118125172218">share</strong>.</li><li id="EN-US_TOPIC_0106040941__li1789218583915">To create a <span id="EN-US_TOPIC_0106040941__text12374348153110">BMS</span><span id="EN-US_TOPIC_0106040941__text113742486311"></span> in a DeC, set this parameter to <strong id="EN-US_TOPIC_0106040941__b19714131313248">dedicate</strong>.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table139542215219"></a><a name="table139542215219"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table139542215219" frame="border" border="1" rules="all"><caption><b>Table 11 </b><strong id="EN-US_TOPIC_0106040941__ae4653c286eb044ff9991627c20769cfb">eip</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row4961433520"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.6.13.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p5914173019189">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.6.13.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p179301830171816">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.6.13.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p109441330141816">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.6.13.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p195813041818">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row796153145219"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p119617316526">iptype</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p19962035526">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p15967310525">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.6.13.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p8961319526">Specifies the EIP type.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p8964311523">Enumerated values: <strong id="EN-US_TOPIC_0106040941__b82405163281">5_bgp</strong> and <strong id="EN-US_TOPIC_0106040941__b15151025192817">5_sbgp</strong></p>
|
||
<p id="EN-US_TOPIC_0106040941__p13328135417469">For details, see the <strong id="EN-US_TOPIC_0106040941__b14768692559">publicip</strong> field in "Assigning an EIP" in <em id="EN-US_TOPIC_0106040941__i167691195559">Elastic IP API Reference</em>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row159663175214"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p296143105212">bandwidth</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p896233528">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p8960345219">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.6.13.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p119615315528">Specifies the EIP bandwidth. For details, see <a href="#EN-US_TOPIC_0106040941__table189859220525">Table 12</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row19376185735116"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p16938114614221">extendparam</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p18938114612212">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.6.13.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p993812462224">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.6.13.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p11938346182214">Provides additional information about the EIP. For details, see <a href="#EN-US_TOPIC_0106040941__table143091715113419">Table 13</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table189859220525"></a><a name="table189859220525"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table189859220525" frame="border" border="1" rules="all"><caption><b>Table 12 </b><strong id="EN-US_TOPIC_0106040941__b176007202177">bandwidth</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row171037315528"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.14.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p6688184061815">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.14.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p18697124018185">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.14.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p1170414018181">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.6.14.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p47121240141815">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row1510312312523"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p1610312315216">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p201031305212">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p1010363165213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.6.14.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p810433105214">Specifies the bandwidth name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row31049318527"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p110418316520">sharetype</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p31047311528">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p210493105213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.6.14.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p21041333529">Specifies the bandwidth sharing type.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p0104631520">Value <strong id="EN-US_TOPIC_0106040941__b20112392133">PER</strong> indicates dedicated bandwidth and <strong id="EN-US_TOPIC_0106040941__b145915313133">WHOLE</strong> indicates shared bandwidth.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row7837104818252"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p196006141846">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p860016141148">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p116001714340">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.6.14.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p4410738292">Specifies the shared bandwidth ID. You can specify an existing shared bandwidth when applying for an EIP with a <strong id="EN-US_TOPIC_0106040941__b481015462135">WHOLE</strong> bandwidth.</p>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note6993141018104"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0106040941__p1911121119104">This parameter is mandatory when <strong id="EN-US_TOPIC_0106040941__b188748366611259">sharetype</strong> is set to <strong id="EN-US_TOPIC_0106040941__b95373651011259">WHOLE</strong>.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row18314122318249"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p201041635526">size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p310453185213">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p1410414345219">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.6.14.2.5.1.4 "><ul id="EN-US_TOPIC_0106040941__ul1859616862316"><li id="EN-US_TOPIC_0106040941__li2596986232">The value ranges from 5 Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can view the bandwidth range of each region on the management console.)</li><li id="EN-US_TOPIC_0106040941__li659612852316">Specifies the bandwidth (Mbit/s). The minimum shared bandwidth is 5 Mbit/s by default.</li></ul>
|
||
<div class="note" id="EN-US_TOPIC_0106040941__note051216345232"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0106040941__ul1158015524298"><li id="EN-US_TOPIC_0106040941__li1012512334619">If a decimal fraction (for example <strong id="EN-US_TOPIC_0106040941__b26078111952">10.2</strong>) or a character string (for example <strong id="EN-US_TOPIC_0106040941__b027818471144">10</strong>) is specified, the specified value will be automatically converted to an integer. If the bandwidth is less than 300 Mbit/s, the step is 1 Mbit/s. If the bandwidth is from 300 Mbit/s to 1000 Mbit/s, the step is 50 Mbit/s. If the bandwidth is from 1000 Mbit/s to 2000 Mbit/s, the step is 1000 Mbit/s.</li><li id="EN-US_TOPIC_0106040941__li12618361163">This parameter is mandatory when <strong id="EN-US_TOPIC_0106040941__b276165742195527">sharetype</strong> is set to <strong id="EN-US_TOPIC_0106040941__b1379441107195527">PER</strong> and is optional when <strong id="EN-US_TOPIC_0106040941__b1701699234195527">sharetype</strong> is set to <strong id="EN-US_TOPIC_0106040941__b1218397550195527">WHOLE</strong> with an ID specified.</li></ul>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row17104633520"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p18104637529">chargemode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p1610443115216">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.14.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p1210413316527">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.6.14.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p16104837521">Specifies the bandwidth billing mode.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p1475015351936">The value can be <strong id="EN-US_TOPIC_0106040941__b94151717121015">traffic</strong> or <strong id="EN-US_TOPIC_0106040941__b7347142321015">bandwidth</strong>.</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul910483145220"><li id="EN-US_TOPIC_0106040941__li121049311521">If this field is not specified, the BMS is billed by bandwidth.</li><li id="EN-US_TOPIC_0106040941__li1104937527">If the field value is empty, the BMS is billed by bandwidth.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table143091715113419"></a><a name="table143091715113419"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table143091715113419" frame="border" border="1" rules="all"><caption><b>Table 13 </b><strong id="EN-US_TOPIC_0106040941__b139371467230">extendparam</strong> field data structure description for assigning an EIP</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row18309191513410"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.6.15.2.5.1.1"><p id="EN-US_TOPIC_0106040941__p15593205710184">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.6.15.2.5.1.2"><p id="EN-US_TOPIC_0106040941__p206001057201814">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.6.15.2.5.1.3"><p id="EN-US_TOPIC_0106040941__p1861065771815">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.15.2.5.1.4"><p id="EN-US_TOPIC_0106040941__p0619957161817">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row530920152344"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.15.2.5.1.1 "><p id="EN-US_TOPIC_0106040941__p730914153340">chargingMode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.6.15.2.5.1.2 "><p id="EN-US_TOPIC_0106040941__p23091715143413">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.6.15.2.5.1.3 "><p id="EN-US_TOPIC_0106040941__p630981511349">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.15.2.5.1.4 "><p id="EN-US_TOPIC_0106040941__p73096156347">Specifies the billing mode of an EIP. If bandwidth is charged by <strong id="EN-US_TOPIC_0106040941__b12109174165516">bandwidth</strong>, both <strong id="EN-US_TOPIC_0106040941__b464446155514">prePaid</strong> and <strong id="EN-US_TOPIC_0106040941__b15840249105515">postPaid</strong> will be available for EIP. If bandwidth is charged by <strong id="EN-US_TOPIC_0106040941__b1478192710564">traffic</strong>, only <strong id="EN-US_TOPIC_0106040941__b797882713573">postPaid</strong> will be available for EIP.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p668615723515">Value range:</p>
|
||
<ul id="EN-US_TOPIC_0106040941__ul1174983616352"><li id="EN-US_TOPIC_0106040941__li0749133618357"><strong id="EN-US_TOPIC_0106040941__b1563527113">prePaid</strong></li><li id="EN-US_TOPIC_0106040941__li1911119454358"><strong id="EN-US_TOPIC_0106040941__b842352706164536">postPaid</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section630483310408"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0106040941__ul15255194761715"><li id="EN-US_TOPIC_0106040941__li525945519474">Creating a pay-per-use <span id="EN-US_TOPIC_0106040941__text1525915552476">BMS</span><span id="EN-US_TOPIC_0106040941__text192591455104717"></span><pre class="screen" id="EN-US_TOPIC_0106040941__screen17943847144919">{
|
||
"server":
|
||
{
|
||
"count": 1,
|
||
"extendparam":
|
||
{
|
||
"chargingMode": "postPaid"
|
||
},
|
||
"vpcid": "8b4e7a59-2bb9-4daf-a31a-2e72db451a3e",
|
||
"name": "bms-local",
|
||
"imageRef": "b7d6d5a1-7588-421c-8730-8a2b5549e5d9",
|
||
"availability_zone": "eu-de-01",
|
||
"nics": [
|
||
{
|
||
"subnet_id": "9cdc46bc-4d1a-44a9-af13-492f533d0299",
|
||
"ip_address": ""
|
||
}],
|
||
"flavorRef": "physical.comtest07.large.ondemand",
|
||
"adminPass": "Test",
|
||
"user_data": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDpIdWF3ZWkxMicgfCBjaHBhc3N3ZCA7",
|
||
"metadata":
|
||
{
|
||
"admin_pass": "",
|
||
"BYOL": "false",
|
||
"op_svc_userid": "e81efc34179c4186bd2bd4f9a2378cac"
|
||
}
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section456114541217"><h4 class="sectiontitle">Response Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table15552174111228" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Normal response</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row8553124172217"><th align="left" class="cellrowborder" valign="top" width="21.872187218721873%" id="mcps1.3.9.2.2.4.1.1"><p id="EN-US_TOPIC_0106040941__p10603113015234">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23.262326232623263%" id="mcps1.3.9.2.2.4.1.2"><p id="EN-US_TOPIC_0106040941__p1160312301231">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="54.865486548654864%" id="mcps1.3.9.2.2.4.1.3"><p id="EN-US_TOPIC_0106040941__p126033304231">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row755354118226"><td class="cellrowborder" valign="top" width="21.872187218721873%" headers="mcps1.3.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p1160383019234">order_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.262326232623263%" headers="mcps1.3.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p1260419308237">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.865486548654864%" headers="mcps1.3.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p17604230162315">Specifies the order ID returned after an order is submitted. You can query the order processing progress based on the ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row20553441162219"><td class="cellrowborder" valign="top" width="21.872187218721873%" headers="mcps1.3.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p10605183018234">job_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.262326232623263%" headers="mcps1.3.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p5605930192316">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.865486548654864%" headers="mcps1.3.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p1260683002313">Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.</p>
|
||
<p id="EN-US_TOPIC_0106040941__p8607113012315">For details about how to query the task execution status based on <strong id="EN-US_TOPIC_0106040941__b465131113245">job_id</strong>, see <a href="en-us_topic_0118696596.html">Querying Task Statuses</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table6467239411151" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Abnormal response</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row2581079811151"><th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.10.2.4.1.1"><p id="EN-US_TOPIC_0106040941__p1029990211151">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.10.2.4.1.2"><p id="EN-US_TOPIC_0106040941__p2898571411151">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="56.379999999999995%" id="mcps1.3.10.2.4.1.3"><p id="EN-US_TOPIC_0106040941__p6614149111151">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row5586052011151"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.10.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p2840824911151">error</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.10.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p1936686411151">Dictionary data structure [1]</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.379999999999995%" headers="mcps1.3.10.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p2558244011151">Specifies the error returned when a task submission encounters an exception. For details, see <a href="#EN-US_TOPIC_0106040941__table6409189311151">error data structure</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="EN-US_TOPIC_0106040941__table6409189311151"></a><a name="table6409189311151"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table6409189311151" frame="border" border="1" rules="all"><caption><b>Table 16 </b><strong id="EN-US_TOPIC_0106040941__b4217161710018">error</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0106040941__row2324327311151"><th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.11.2.4.1.1"><p id="EN-US_TOPIC_0106040941__p365693111151">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.11.2.4.1.2"><p id="EN-US_TOPIC_0106040941__p2777597711151">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="56.46%" id="mcps1.3.11.2.4.1.3"><p id="EN-US_TOPIC_0106040941__p3526170111151">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row3762550011151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.11.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p2776668011151">message</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.11.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p3450864111151">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.11.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p4373654211151">Specifies the error message.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="EN-US_TOPIC_0106040941__row5808456411151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.11.2.4.1.1 "><p id="EN-US_TOPIC_0106040941__p722924311151">code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.11.2.4.1.2 "><p id="EN-US_TOPIC_0106040941__p4869780211151">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.11.2.4.1.3 "><p id="EN-US_TOPIC_0106040941__p5220791411151">Specifies the error code.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section12587161132513"><h4 class="sectiontitle">Example Response</h4><ul id="EN-US_TOPIC_0106040941__ul1743122492512"><li id="EN-US_TOPIC_0106040941__li07431424142513">Normal response<pre class="screen" id="EN-US_TOPIC_0106040941__screen16729122072518">{
|
||
"order_id": "CS2009141523OQSEQ",
|
||
"job_id": "ff808081748b760c01748b7f80370003"
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0106040941__p193201622141412">Normal values
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0106040941__table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0106040941__row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.13.2.1.1.3.1.1"><p id="EN-US_TOPIC_0106040941__p19735204616177">Returned Values</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.13.2.1.1.3.1.2"><p id="EN-US_TOPIC_0106040941__p207355465176">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="EN-US_TOPIC_0106040941__row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.13.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0106040941__p13735144611178">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.13.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0106040941__p207351246161711">The request has been successfully processed.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<p id="EN-US_TOPIC_0106040941__p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
|
||
</div>
|
||
<div class="section" id="EN-US_TOPIC_0106040941__section7469181014915"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0106040941__p10243161417491">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0113746488.html">BMS Lifecycle Management</a></div>
|
||
</div>
|
||
</div>
|
||
|