doc-exports/docs/ecs/api-ref/en-us_topic_0167957246.html
Zaoxu, Li 4edaa4a4cc ECS API 20231016 version
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-04-29 11:04:13 +00:00

517 lines
59 KiB
HTML

<a name="EN-US_TOPIC_0167957246"></a><a name="EN-US_TOPIC_0167957246"></a>
<h1 class="topictitle1">Data Structure for Creating <span id="text2060419162576">ECS</span>s</h1>
<div id="body1556605125235"><div class="section" id="EN-US_TOPIC_0167957246__section1235152713529"><h4 class="sectiontitle">Contents</h4><ul id="EN-US_TOPIC_0167957246__ul148531111553"><li id="EN-US_TOPIC_0167957246__li38561120557"><a href="#EN-US_TOPIC_0167957246__section1846944811410">publicip Field Description</a></li><li id="EN-US_TOPIC_0167957246__li19853115553"><a href="#EN-US_TOPIC_0167957246__section332191084315">security_groups Field Description</a></li><li id="EN-US_TOPIC_0167957246__li108541118551"><a href="#EN-US_TOPIC_0167957246__section1840318312449">eip Field Description</a></li><li id="EN-US_TOPIC_0167957246__li1285141111554"><a href="#EN-US_TOPIC_0167957246__section172789339448">bandwidth Field Description</a></li><li id="EN-US_TOPIC_0167957246__li134033071013"><a href="#EN-US_TOPIC_0167957246__section2872318176">ipv6_bandwidth Field Description</a></li><li id="EN-US_TOPIC_0167957246__li2851511165516"><a href="#EN-US_TOPIC_0167957246__section1361484104817">extendparam Field Description for Creating Disks</a></li><li id="EN-US_TOPIC_0167957246__li1785201115511"><a href="#EN-US_TOPIC_0167957246__section1373711413505">extendparam Field Description for Creating ECSs</a></li><li id="EN-US_TOPIC_0167957246__li1685111115510"><a href="#EN-US_TOPIC_0167957246__section1228814491353">metadata Field Description for Creating Disks</a></li><li id="EN-US_TOPIC_0167957246__li1785191185517"><a href="#EN-US_TOPIC_0167957246__section1574435185018">metadata Field Description for Creating ECSs</a></li><li id="EN-US_TOPIC_0167957246__li2920114559"><a href="#EN-US_TOPIC_0167957246__section16585034175117">os:scheduler_hints Field Description</a></li><li id="EN-US_TOPIC_0167957246__li79318118556"><a href="#EN-US_TOPIC_0167957246__section681114217434">binding:profile Field Description</a></li><li id="EN-US_TOPIC_0167957246__li12931511105511"><a href="#EN-US_TOPIC_0167957246__section12781010134512">extra_dhcp_opts Field Description</a></li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1846944811410"><a name="EN-US_TOPIC_0167957246__section1846944811410"></a><a name="section1846944811410"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b09562405313">publicip</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p1130813614428">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul02013253427"><li id="EN-US_TOPIC_0167957246__li16201102524212">Creating <span id="EN-US_TOPIC_0167957246__text777182185717">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table2785183710710"></a><a name="table2785183710710"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table2785183710710" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="EN-US_TOPIC_0167957246__b171691635121117">publicip</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row7093323"><th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p655704815421">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.54%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p165571448114214">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p45727487425">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.56%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p13572124817427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row38559395"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p21035367101953">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p37294877102020">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p37223744101953">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p36517316174333">Specifies the ID of the existing EIP assigned to the ECS to be created. The value is in UUID format.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p60220392174333">Only EIPs in <strong id="EN-US_TOPIC_0167957246__b13544532121817">DOWN</strong> state can be assigned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row4762671410201"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p2598724810201">eip</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p2459235410201">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p4582368110201">Object</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p2073067610201">Specifies an EIP that will be automatically assigned to an ECS.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p19810844172712">For details, see <a href="#EN-US_TOPIC_0167957246__table020717438159">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row8587238595"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p6581723105918">delete_on_termination</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p85819234592">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p9582235594">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.56%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p15842320592">Specifies whether the EIP is released when the ECS where the EIP is bound is deleted.</p>
<ul id="EN-US_TOPIC_0167957246__ul129302045509"><li id="EN-US_TOPIC_0167957246__li199301845407"><strong id="EN-US_TOPIC_0167957246__b6369033329">true</strong>: The EIP is released when the ECS is deleted.</li><li id="EN-US_TOPIC_0167957246__li185457356113"><strong id="EN-US_TOPIC_0167957246__b1779912873610">false</strong>: The EIP is not released when the ECS is deleted.</li></ul>
<p id="EN-US_TOPIC_0167957246__p1685882116313">The default value is <strong id="EN-US_TOPIC_0167957246__b38206293612">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0167957246__note5281151312431"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__p14893319194318">Either <strong id="EN-US_TOPIC_0167957246__b1942041736">id</strong> or <strong id="EN-US_TOPIC_0167957246__b1943411532">eip</strong> in the <strong id="EN-US_TOPIC_0167957246__b14184110317">publicip</strong> field can be configured.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section332191084315"><a name="EN-US_TOPIC_0167957246__section332191084315"></a><a name="section332191084315"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b18518413312">security_groups</strong> Field Description</h4><p id="EN-US_TOPIC_0167957246__p612013814432">This field is used by the following APIs:</p>
<ul id="EN-US_TOPIC_0167957246__ul172843310157"><li id="EN-US_TOPIC_0167957246__li372915336159">Creating <span id="EN-US_TOPIC_0167957246__text475412465714">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
<div class="p" id="EN-US_TOPIC_0167957246__p1641822320158">
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table1698566599"></a><a name="table1698566599"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table1698566599" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0167957246__b67191641131320">security_groups</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row51142457"><th align="left" class="cellrowborder" valign="top" width="18.7981201879812%" id="mcps1.3.3.4.1.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p17968192484320">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.168383161683835%" id="mcps1.3.3.4.1.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p19832247434">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.66823317668233%" id="mcps1.3.3.4.1.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p99833249439">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.36526347365263%" id="mcps1.3.3.4.1.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p13999172414438">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row34524340"><td class="cellrowborder" valign="top" width="18.7981201879812%" headers="mcps1.3.3.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p45008187">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.168383161683835%" headers="mcps1.3.3.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p21784493">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.66823317668233%" headers="mcps1.3.3.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p19713524">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.3.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p3313237174650">Specifies the ID of the security group to which an <span id="EN-US_TOPIC_0167957246__text1481312250575">ECS</span> is to be added. The configuration will take effect on the NICs of the <span id="EN-US_TOPIC_0167957246__text53071141441">ECS</span>. You need to specify the ID of an existing security group in UUID format. Otherwise, the default security group will be used at the underlying layer.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1840318312449"><a name="EN-US_TOPIC_0167957246__section1840318312449"></a><a name="section1840318312449"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b4231417310">eip</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p11864617164416">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul1864131717444"><li id="EN-US_TOPIC_0167957246__li10864191714415">Creating <span id="EN-US_TOPIC_0167957246__text38341927155714">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table020717438159"></a><a name="table020717438159"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table020717438159" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0167957246__b322344915146">eip</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__row142051643161515"><th align="left" class="cellrowborder" valign="top" width="16.666666666666668%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__p220520436158">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.666666666666668%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__p1920514312151">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.725490196078432%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__p520584317151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.94117647058824%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__p920514331510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__row6206174311511"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p22055434158">iptype</p>
</td>
<td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p9205194311515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.725490196078432%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p8206104311514">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94117647058824%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p142060437155">Specifies the EIP type.</p>
<p id="EN-US_TOPIC_0167957246__p102068433158">For details about the enumerated values, see the <strong id="EN-US_TOPIC_0167957246__b08876115150">publicip</strong> field in "Assigning an EIP" in <em id="EN-US_TOPIC_0167957246__i68884113159">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row52079430153"><td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p1320604312157">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="16.666666666666668%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p1720634381517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.725490196078432%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p152067435153">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.94117647058824%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p920618437151">Specifies the bandwidth of an EIP.</p>
<p id="EN-US_TOPIC_0167957246__p172071043111520">For details, see <a href="en-us_topic_0167957246.html#EN-US_TOPIC_0167957246__section172789339448">bandwidth Field Description</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section172789339448"><a name="EN-US_TOPIC_0167957246__section172789339448"></a><a name="section172789339448"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b458141332">bandwidth</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p17390135712447">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul13901457144418"><li id="EN-US_TOPIC_0167957246__li03901457204412">Creating <span id="EN-US_TOPIC_0167957246__text082029155711">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table16301415102451" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0167957246__b2488160191717">bandwidth</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row17791119102758"><th align="left" class="cellrowborder" valign="top" width="18.473001741823104%" id="mcps1.3.5.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p940919329434">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.921811496032515%" id="mcps1.3.5.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1542583214315">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.653957809173601%" id="mcps1.3.5.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p20425183274314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.95122895297078%" id="mcps1.3.5.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p15440183294320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row5196896102758"><td class="cellrowborder" valign="top" width="18.473001741823104%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p18295456102758">size</p>
</td>
<td class="cellrowborder" valign="top" width="11.921811496032515%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p5536985102758">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.653957809173601%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p45842610102758">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.95122895297078%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p1875653414718">Specifies the bandwidth size.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p11589040111711">Specifies the bandwidth (Mbit/s). The value ranges from 1 to 1,000.</p>
<p id="EN-US_TOPIC_0167957246__p1074594143310">The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row66157294102758"><td class="cellrowborder" valign="top" width="18.473001741823104%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p57140623102758">sharetype</p>
</td>
<td class="cellrowborder" valign="top" width="11.921811496032515%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p64987789102758">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.653957809173601%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p29519567102758">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.95122895297078%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p44928433102758">Specifies the bandwidth sharing type.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p226836615358">Enumerated values: <strong id="EN-US_TOPIC_0167957246__b842352706114517">PER</strong> (indicates exclusive bandwidth) and <strong id="EN-US_TOPIC_0167957246__b842352706114521">WHOLE</strong> (indicates sharing)</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row66831921141019"><td class="cellrowborder" valign="top" width="18.473001741823104%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p44676503141019">chargemode</p>
</td>
<td class="cellrowborder" valign="top" width="11.921811496032515%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p62027027141019">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.653957809173601%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p58133258141019">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.95122895297078%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p11173478141019">Specifies the bandwidth billing mode.</p>
<ul id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_ul23956879141348"><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li18851523141348">If the field value is <strong id="EN-US_TOPIC_0167957246__b16182133682513">traffic</strong>, the ECS is billed by traffic.</li><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li28855496141348">If the field value is others, creating the <span id="EN-US_TOPIC_0167957246__text1682330165713">ECS</span> will fail.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section2872318176"><a name="EN-US_TOPIC_0167957246__section2872318176"></a><a name="section2872318176"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b1832410536288">ipv6_bandwidth</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p123901327402">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul1739102124013"><li id="EN-US_TOPIC_0167957246__li183912029402">Creating <span id="EN-US_TOPIC_0167957246__text1230006032">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table121459141616" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0167957246__b84235270695528">ipv6_bandwidth</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row61375819149"><th align="left" class="cellrowborder" valign="top" width="22.81%" id="mcps1.3.6.2.2.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p179114321519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.87%" id="mcps1.3.6.2.2.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p892163151517">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.87%" id="mcps1.3.6.2.2.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p17930738157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.449999999999996%" id="mcps1.3.6.2.2.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p9942123161517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row1113195820140"><td class="cellrowborder" valign="top" width="22.81%" headers="mcps1.3.6.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p14131058131412">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.87%" headers="mcps1.3.6.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p313175819143">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.87%" headers="mcps1.3.6.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1713125820148">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.449999999999996%" headers="mcps1.3.6.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p580912373152">Specifies the ID of an IPv6 bandwidth.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1361484104817"><a name="EN-US_TOPIC_0167957246__section1361484104817"></a><a name="section1361484104817"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b842352706201741">extendparam</strong> Field Description for Creating Disks</h4><p id="EN-US_TOPIC_0167957246__p139721455174812">This field is used by the following APIs:</p>
<ul id="EN-US_TOPIC_0167957246__ul38671635191711"><li id="EN-US_TOPIC_0167957246__li138671635131720">Creating <span id="EN-US_TOPIC_0167957246__text98263317572">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
<div class="p" id="EN-US_TOPIC_0167957246__p18592141931719">
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table7562101331712"></a><a name="table7562101331712"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table7562101331712" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0167957246__b889528595">extendparam</strong> field description for creating disks</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row4999061312178"><th align="left" class="cellrowborder" valign="top" width="18.988101189881014%" id="mcps1.3.7.4.1.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p159171369431">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.978402159784022%" id="mcps1.3.7.4.1.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p19933936124315">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.66823317668233%" id="mcps1.3.7.4.1.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p59331136154317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.36526347365263%" id="mcps1.3.7.4.1.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1294943624317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row98284261548"><td class="cellrowborder" valign="top" width="18.988101189881014%" headers="mcps1.3.7.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p158291026105416">snapshotId</p>
</td>
<td class="cellrowborder" valign="top" width="15.978402159784022%" headers="mcps1.3.7.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p9829182612547">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.66823317668233%" headers="mcps1.3.7.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1082942655420">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.7.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p165161345194219">Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p12838424153912"><strong id="EN-US_TOPIC_0167957246__b1778912241786">Application scenarios:</strong></p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p8101134111396">This parameter is used if an ECS is created using a full-ECS image, and the image contains one or more data disks.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p10347156194311">If you use a full-ECS image to create an ECS, the system automatically restores the data type and data from the data disks in the image. The <strong id="EN-US_TOPIC_0167957246__b842352706185910">snapshotId</strong> parameter allows you to specify the disk type for the original data disk after restoration.</p>
<div class="note" id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_note20821102313353"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_ul18479202511419"><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li13479132524117">You are advised to specify <strong id="EN-US_TOPIC_0167957246__b897620975116">snapshotId</strong> for each original data disk.</li><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li4476182715414">If you are required to change a disk size, ensure that the changed disk size is greater than or equal to the size of the original data disk. Otherwise, restoring data of the original data disk will fail.</li><li id="EN-US_TOPIC_0167957246__li3476326155410">To set disk sharing, you need to specify the sharing attribute.</li><li id="EN-US_TOPIC_0167957246__li17167195310546">To set disk encryption, you need to specify the encryption attribute in the metadata field.</li></ul>
</div></div>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p18951356175713"><strong id="EN-US_TOPIC_0167957246__b198571395918">Working rules:</strong></p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p916611325812"><strong id="EN-US_TOPIC_0167957246__b84235270619443">snapshotId</strong> uniquely identifies an original data disk contained in a full-ECS image. You can use <strong id="EN-US_TOPIC_0167957246__b132452214819538">snapshotId</strong> to obtain the information of the original data disk for data restoration.</p>
<p id="EN-US_TOPIC_0167957246__p29793189319"><strong id="EN-US_TOPIC_0167957246__b1045712161101">Obtaining snapshotId through the management console:</strong></p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p179131302432">Log in to the management console, choose <strong id="EN-US_TOPIC_0167957246__b842352706145529">Elastic Volume Service</strong> &gt; <strong id="EN-US_TOPIC_0167957246__b842352706145535">Snapshot</strong>. Then, use the name of the original data disk to find the snapshot ID or the original disk ID.</p>
<p id="EN-US_TOPIC_0167957246__p93941230183116"><strong id="EN-US_TOPIC_0167957246__b1265110520118">Obtaining snapshotId through the API:</strong></p>
<div class="p" id="EN-US_TOPIC_0167957246__p525262911283">If you have obtained the full-ECS image ID, obtain the Cloud Backup and Recovery (CBR) or Cloud Server Backup Service (CSBS) backup ID associated with the full-ECS image ID by following the instructions provided in the API for querying image details.<ul id="EN-US_TOPIC_0167957246__ul610116235288"><li id="EN-US_TOPIC_0167957246__li1410182322815">If CBR backup is used, use the CBR backup ID to obtain the backup. The <strong id="EN-US_TOPIC_0167957246__b1296018611123">resource_id</strong> or <strong id="EN-US_TOPIC_0167957246__b196116619127">snapshot_id</strong> contained in the children field in the response is the desired <strong id="EN-US_TOPIC_0167957246__b1496217619127">snapshotId</strong>. For details, see the API for "Querying a Specified Backup" in <em id="EN-US_TOPIC_0167957246__i17588183611215">Cloud Backup and Recovery User Guide</em>.</li><li id="EN-US_TOPIC_0167957246__li210162332815">If CSBS backup is used, use the CSBS backup ID to obtain the backup. The <strong id="EN-US_TOPIC_0167957246__b5644103615138">source_volume_id</strong> or <strong id="EN-US_TOPIC_0167957246__b4645136141320">snapshot_id</strong> contained in the <strong id="EN-US_TOPIC_0167957246__b364503631312">volume_backups</strong> field in the response is the desired <strong id="EN-US_TOPIC_0167957246__b156451736171318">snapshotId</strong>. For details, see the API for "Querying a Single Backup" in <em id="EN-US_TOPIC_0167957246__i1034939181416">Cloud Server Backup Service User Guide</em>.</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1373711413505"><a name="EN-US_TOPIC_0167957246__section1373711413505"></a><a name="section1373711413505"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b9474161210599">extendparam</strong> Field Description for Creating <span id="EN-US_TOPIC_0167957246__text167141232195714">ECS</span>s</h4><div class="p" id="EN-US_TOPIC_0167957246__p127381144508">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul1273824135019"><li id="EN-US_TOPIC_0167957246__li157383455014">Creating <span id="EN-US_TOPIC_0167957246__text1490153314578">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table1137234112314"></a><a name="table1137234112314"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table1137234112314" frame="border" border="1" rules="all"><caption><b>Table 7 </b>extendparam field description for creating <span id="EN-US_TOPIC_0167957246__text162825345571">ECS</span>s (for V1 APIs)</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row908051512314"><th align="left" class="cellrowborder" valign="top" width="22.040000000000003%" id="mcps1.3.8.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p11836154112432">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.98%" id="mcps1.3.8.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p585210410437">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.93%" id="mcps1.3.8.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p18852134118436">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.05%" id="mcps1.3.8.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p78681541114315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row30217817123156"><td class="cellrowborder" valign="top" width="22.040000000000003%" headers="mcps1.3.8.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p3524901123156">regionID</p>
</td>
<td class="cellrowborder" valign="top" width="12.98%" headers="mcps1.3.8.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p17081589123156">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.93%" headers="mcps1.3.8.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p41431486123156">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.05%" headers="mcps1.3.8.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p507175123156">Specifies the ID of the region where the <span id="EN-US_TOPIC_0167957246__text099623445718">ECS</span> resides.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0167957246__p188351341111315"></p>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1228814491353"><a name="EN-US_TOPIC_0167957246__section1228814491353"></a><a name="section1228814491353"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b1225218541538">metadata</strong> Field Description for Creating Disks</h4><p id="EN-US_TOPIC_0167957246__p162881149456">This field is used by the following APIs:</p>
<ul id="EN-US_TOPIC_0167957246__ul928818492518"><li id="EN-US_TOPIC_0167957246__li202884495518">Creating <span id="EN-US_TOPIC_0167957246__text15918125319570">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
<div class="note" id="EN-US_TOPIC_0167957246__note3447848164017"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0167957246__ul157174117426"><li id="EN-US_TOPIC_0167957246__li1544416144431">When you create an ECS, both <strong id="EN-US_TOPIC_0167957246__b3971527123815">root_volume</strong> and <strong id="EN-US_TOPIC_0167957246__b1951131123818">data_volume</strong> contain the <strong id="EN-US_TOPIC_0167957246__b321641133812">metadata</strong> field.</li></ul>
</div></div>
<div class="p" id="EN-US_TOPIC_0167957246__p2288349155">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table1028814491351" frame="border" border="1" rules="all"><caption><b>Table 8 </b><strong id="EN-US_TOPIC_0167957246__b176744397418">metadata</strong> field description for creating disks</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__row14289749355"><th align="left" class="cellrowborder" valign="top" width="18.556701030927837%" id="mcps1.3.9.5.1.2.5.1.1"><p id="EN-US_TOPIC_0167957246__p142893491958">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.49484536082474%" id="mcps1.3.9.5.1.2.5.1.2"><p id="EN-US_TOPIC_0167957246__p1128918494518">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.309278350515465%" id="mcps1.3.9.5.1.2.5.1.3"><p id="EN-US_TOPIC_0167957246__p202891549251">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.639175257731964%" id="mcps1.3.9.5.1.2.5.1.4"><p id="EN-US_TOPIC_0167957246__p328918491518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__row10289249156"><td class="cellrowborder" valign="top" width="18.556701030927837%" headers="mcps1.3.9.5.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p1562408795622">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="16.49484536082474%" headers="mcps1.3.9.5.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p5759155095622">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.309278350515465%" headers="mcps1.3.9.5.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p3440400295622">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.639175257731964%" headers="mcps1.3.9.5.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p729227516614">Specifies encryption in <strong id="EN-US_TOPIC_0167957246__b2039276207171318">metadata</strong>. The value can be <strong id="EN-US_TOPIC_0167957246__b815044561171318">0</strong> (encryption disabled) or <strong id="EN-US_TOPIC_0167957246__b1102444237171318">1</strong> (encryption enabled).</p>
<p id="EN-US_TOPIC_0167957246__p3526077895622">If this parameter does not exist, the disk will not be encrypted by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row428914491452"><td class="cellrowborder" valign="top" width="18.556701030927837%" headers="mcps1.3.9.5.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p241272995622">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="16.49484536082474%" headers="mcps1.3.9.5.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p683657101711">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.309278350515465%" headers="mcps1.3.9.5.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p5933737595622">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.639175257731964%" headers="mcps1.3.9.5.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p20670814113715">Specifies the CMK ID, which indicates encryption in <strong id="EN-US_TOPIC_0167957246__b18651112211379">metadata</strong>. This parameter is used with <strong id="EN-US_TOPIC_0167957246__b891155174413">__system__encrypted</strong>.</p>
<div class="note" id="EN-US_TOPIC_0167957246__note153392271895"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__p35971634891">For details about how to obtain the CMK ID, see "Querying the List of CMKs" in <em id="EN-US_TOPIC_0167957246__i185111076413">Key Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section1574435185018"><a name="EN-US_TOPIC_0167957246__section1574435185018"></a><a name="section1574435185018"></a><h4 class="sectiontitle">metadata Field Description for Creating <span id="EN-US_TOPIC_0167957246__text077125475711">ECS</span>s</h4><p id="EN-US_TOPIC_0167957246__p193175475016">This field is used by the following APIs:</p>
<ul id="EN-US_TOPIC_0167957246__ul882532213182"><li id="EN-US_TOPIC_0167957246__li3825102218187">Creating <span id="EN-US_TOPIC_0167957246__text19671568571">ECS</span>s /v1/{project_id}/cloudservers</li></ul>
<div class="p" id="EN-US_TOPIC_0167957246__p1687121841820">
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table2373623012315"></a><a name="table2373623012315"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table2373623012315" frame="border" border="1" rules="all"><caption><b>Table 9 </b><strong id="EN-US_TOPIC_0167957246__b2068819594266">metadata</strong> reserved field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row4787810512315"><th align="left" class="cellrowborder" valign="top" width="21.617838216178384%" id="mcps1.3.10.4.1.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p135337462439">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.448655134486554%" id="mcps1.3.10.4.1.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1853324694312">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.48835116488351%" id="mcps1.3.10.4.1.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p2054974617431">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.445155484451554%" id="mcps1.3.10.4.1.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p75495461436">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row1137835517246"><td class="cellrowborder" valign="top" width="21.617838216178384%" headers="mcps1.3.10.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p3877115254">admin_pass</p>
</td>
<td class="cellrowborder" valign="top" width="13.448655134486554%" headers="mcps1.3.10.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p28712114258">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.48835116488351%" headers="mcps1.3.10.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p587610259">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.445155484451554%" headers="mcps1.3.10.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1587815251">Specifies the password of user <strong id="EN-US_TOPIC_0167957246__b370222417279">Administrator</strong> for logging in to a Windows <span id="EN-US_TOPIC_0167957246__text4891183185818">ECS</span>. For details, see <a href="en-us_topic_0020212668.html#EN-US_TOPIC_0020212668__section61372619">Function</a>.</p>
<div class="note" id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_note178716152516"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p158717113250">This parameter is mandatory when a Windows <span id="EN-US_TOPIC_0167957246__text918316355274">ECS</span> using password authentication is created.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row123659618318"><td class="cellrowborder" valign="top" width="21.617838216178384%" headers="mcps1.3.10.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1585813419425">op_svc_userid</p>
</td>
<td class="cellrowborder" valign="top" width="13.448655134486554%" headers="mcps1.3.10.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p30970240152124">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.48835116488351%" headers="mcps1.3.10.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p25561503152124">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.445155484451554%" headers="mcps1.3.10.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p57215887152124">Specifies the user ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row188201635161913"><td class="cellrowborder" valign="top" width="21.617838216178384%" headers="mcps1.3.10.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p482163517190">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.448655134486554%" headers="mcps1.3.10.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p3821143561911">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.48835116488351%" headers="mcps1.3.10.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p38217353191">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.445155484451554%" headers="mcps1.3.10.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p0842044134818">Specifies the IAM agency name.</p>
<p id="EN-US_TOPIC_0167957246__p9821153514191">An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for <span id="EN-US_TOPIC_0167957246__text1621392595810">ECS</span>s to access cloud services.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row064283453716"><td class="cellrowborder" valign="top" width="21.617838216178384%" headers="mcps1.3.10.4.1.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__p106421334173713">BYOL</p>
</td>
<td class="cellrowborder" valign="top" width="13.448655134486554%" headers="mcps1.3.10.4.1.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__p61751455193711">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.48835116488351%" headers="mcps1.3.10.4.1.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__p151751555153714">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.445155484451554%" headers="mcps1.3.10.4.1.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__p38630165383">If you have an OS or a software license (a license certified based on the number of physical servers and cores), you can migrate your services to the cloud platform in BYOL mode to continue using your existing licenses.</p>
<ul id="EN-US_TOPIC_0167957246__ul49552211382"><li id="EN-US_TOPIC_0167957246__li695822113817"><strong id="EN-US_TOPIC_0167957246__b6975325213">True</strong>: Use your existing licenses.</li><li id="EN-US_TOPIC_0167957246__li79512224387"><strong id="EN-US_TOPIC_0167957246__b676121118535">False</strong>: System licenses are used.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section16585034175117"><a name="EN-US_TOPIC_0167957246__section16585034175117"></a><a name="section16585034175117"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b84235270620940">os:scheduler_hints</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p1954916501157">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul16757853854"><li id="EN-US_TOPIC_0167957246__li37571653453">Creating <span id="EN-US_TOPIC_0167957246__text19283534145812">ECS</span>s: /v1/{project_id}/cloudservers</li><li id="EN-US_TOPIC_0167957246__li19757115316515">Creating ECSs (native): /v2.1/{project_id}/servers</li></ul>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table24430409172542"></a><a name="table24430409172542"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table24430409172542" frame="border" border="1" rules="all"><caption><b>Table 10 </b><strong id="EN-US_TOPIC_0167957246__b59881545135418">os:scheduler_hints</strong> field description (request parameters)</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row5164550172542"><th align="left" class="cellrowborder" valign="top" width="22.747725227477254%" id="mcps1.3.11.2.2.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1649754984312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.418558144185582%" id="mcps1.3.11.2.2.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p10512194974320">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.468453154684534%" id="mcps1.3.11.2.2.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p13512164915435">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.36526347365263%" id="mcps1.3.11.2.2.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p15528949104315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row16191828172542"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.11.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p4448806918565">group</p>
</td>
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.11.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1252936172542">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.468453154684534%" headers="mcps1.3.11.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p34378991172542">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.11.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p33234878172542">Specifies the ECS group ID in UUID format.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1295251611495">Obtain the parameter value from the console or by referring to <a href="en-us_topic_0065817721.html">Querying ECS Groups</a>.</p>
<div class="note" id="EN-US_TOPIC_0167957246__note1994442816299"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__p12944132817299">Ensure that the ECS group uses the anti-affinity policy.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row4670511154836"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.11.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p9464792154850">tenancy</p>
</td>
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.11.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p28450689154850">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.468453154684534%" headers="mcps1.3.11.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p22804507154850">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.11.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p35225806154850">Creates <span id="EN-US_TOPIC_0167957246__text10394644135810">ECS</span>s on a dedicated or shared host.</p>
<p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p48596800154850">The value of this parameter can be <strong id="EN-US_TOPIC_0167957246__b84235270693435">dedicated</strong> or <strong id="EN-US_TOPIC_0167957246__b84235270693438">shared</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row35777762154842"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.11.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p60695964154850">dedicated_host_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.418558144185582%" headers="mcps1.3.11.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p17426056154850">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.468453154684534%" headers="mcps1.3.11.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p2224428154850">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.11.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p45961009154850">Specifies the dedicated host ID.</p>
<div class="note" id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_note104335662920"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p238416346291">A DeH ID takes effect only when <strong id="EN-US_TOPIC_0167957246__b842352706191448">tenancy</strong> is set to <strong id="EN-US_TOPIC_0167957246__b842352706191453">dedicated</strong>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="p" id="EN-US_TOPIC_0167957246__p610925873419">
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table3756175217341"></a><a name="table3756175217341"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table3756175217341" frame="border" border="1" rules="all"><caption><b>Table 11 </b><strong id="EN-US_TOPIC_0167957246__b178451432185">os:scheduler_hints</strong> field description (response parameters)</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__row4755552173413"><th align="left" class="cellrowborder" valign="top" width="17.64705882352941%" id="mcps1.3.11.3.1.2.4.1.1"><p id="EN-US_TOPIC_0167957246__p15754135273418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.64705882352941%" id="mcps1.3.11.3.1.2.4.1.2"><p id="EN-US_TOPIC_0167957246__p275475243417">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.70588235294117%" id="mcps1.3.11.3.1.2.4.1.3"><p id="EN-US_TOPIC_0167957246__p075511528340">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__row7755252113413"><td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0167957246__p37551452103414">group</p>
</td>
<td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0167957246__p2075535243414">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="64.70588235294117%" headers="mcps1.3.11.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0167957246__p15755185203413">Specifies the ECS group ID in UUID format.</p>
<p id="EN-US_TOPIC_0167957246__p775517524342">Obtain the parameter value from the console or by referring to <a href="en-us_topic_0065817721.html">Querying ECS Groups</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row11755165214341"><td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0167957246__p19755155223415">tenancy</p>
</td>
<td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0167957246__p1875525203412">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="64.70588235294117%" headers="mcps1.3.11.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0167957246__p2075515233412">Creates <span id="EN-US_TOPIC_0167957246__text47531458105820">ECS</span>s on a dedicated or shared host.</p>
<p id="EN-US_TOPIC_0167957246__p475545223418">The value of this parameter can be <strong id="EN-US_TOPIC_0167957246__b1550630622">dedicated</strong> or <strong id="EN-US_TOPIC_0167957246__b204702242">shared</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__row19755145243414"><td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0167957246__p127551852113411">dedicated_host_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.64705882352941%" headers="mcps1.3.11.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0167957246__p775595210342">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="64.70588235294117%" headers="mcps1.3.11.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0167957246__p15755145218349">Specifies the dedicated host ID.</p>
<div class="note" id="EN-US_TOPIC_0167957246__note197550525344"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0167957246__p1755952203411">A DeH ID takes effect only when <strong id="EN-US_TOPIC_0167957246__b1032151939">tenancy</strong> is set to <strong id="EN-US_TOPIC_0167957246__b1046085214">dedicated</strong>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section681114217434"><a name="EN-US_TOPIC_0167957246__section681114217434"></a><a name="section681114217434"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b5838941535">binding:profile</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p3773952184318">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul7773155274310"><li id="EN-US_TOPIC_0167957246__li18773852184315">Creating ECSs: /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table42451440577"></a><a name="table42451440577"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table42451440577" frame="border" border="1" rules="all"><caption><b>Table 12 </b><strong id="EN-US_TOPIC_0167957246__b161421834615">binding:profile</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row527424465711"><th align="left" class="cellrowborder" valign="top" width="22.747725227477254%" id="mcps1.3.12.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p327225311433">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.84851514848515%" id="mcps1.3.12.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p12881953184318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.038496150384962%" id="mcps1.3.12.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p828865316433">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.36526347365263%" id="mcps1.3.12.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1530345324320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row4319184413579"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.12.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p5943195315816">disable_security_groups</p>
</td>
<td class="cellrowborder" valign="top" width="14.84851514848515%" headers="mcps1.3.12.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1933114417571">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.038496150384962%" headers="mcps1.3.12.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p11337144105712">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.12.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p20347144419574">Specifies whether the NIC of an ECS is not added to a security group.</p>
<div class="note" id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_note12688551006"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_ul11762133368"><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li576216312611">The primary NIC of the ECS must be added to a security group.</li><li id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_li1976212315618">At most one NIC of the ECS is allowed not to be added to any security groups.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0167957246__section12781010134512"><a name="EN-US_TOPIC_0167957246__section12781010134512"></a><a name="section12781010134512"></a><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0167957246__b84235270691152">extra_dhcp_opts</strong> Field Description</h4><div class="p" id="EN-US_TOPIC_0167957246__p15751323144515">This field is used by the following APIs:<ul id="EN-US_TOPIC_0167957246__ul1975152311451"><li id="EN-US_TOPIC_0167957246__li1075323144510">Creating ECSs: /v1/{project_id}/cloudservers</li></ul>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0167957246__table93959401279"></a><a name="table93959401279"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0167957246__table93959401279" frame="border" border="1" rules="all"><caption><b>Table 13 </b><strong id="EN-US_TOPIC_0167957246__b86022851">extra_dhcp_opts</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row1142718406718"><th align="left" class="cellrowborder" valign="top" width="22.747725227477254%" id="mcps1.3.13.3.2.5.1.1"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p83691007441">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.84851514848515%" id="mcps1.3.13.3.2.5.1.2"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p136919015446">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.038496150384962%" id="mcps1.3.13.3.2.5.1.3"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1338616034416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.36526347365263%" id="mcps1.3.13.3.2.5.1.4"><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p73861404449">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row15468840872"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.13.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p147617408712">opt_value</p>
</td>
<td class="cellrowborder" valign="top" width="14.84851514848515%" headers="mcps1.3.13.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p5483104013713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.038496150384962%" headers="mcps1.3.13.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p34905405716">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.13.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1850016404713">Specifies the NIC MTU, which ranges from 1280 to 8888.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_row1350416401775"><td class="cellrowborder" valign="top" width="22.747725227477254%" headers="mcps1.3.13.3.2.5.1.1 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p1651164016710">opt_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.84851514848515%" headers="mcps1.3.13.3.2.5.1.2 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p85191040476">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.038496150384962%" headers="mcps1.3.13.3.2.5.1.3 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p14526154019715">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.36526347365263%" headers="mcps1.3.13.3.2.5.1.4 "><p id="EN-US_TOPIC_0167957246__en-us_topic_0020212668_p135322401179">Set the parameter value to <strong id="EN-US_TOPIC_0167957246__b1598982315913">26</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0175308115.html">Data Structure</a></div>
</div>
</div>