vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/eip/api-ref/eip_api_0001.html
Qin Ying, Fan aca2e5c333 EIP API 1027 version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-31 11:11:49 +00:00

309 lines
35 KiB
HTML
Raw Blame History

<a name="eip_api_0001"></a><a name="eip_api_0001"></a>
<h1 class="topictitle1">Assigning an EIP </h1>
<div id="body8662426"><div class="section" id="eip_api_0001__en-us_topic_0201534274_section12153337"><h4 class="sectiontitle">Function</h4><p id="eip_api_0001__en-us_topic_0201534274_p10483995">This API is used to assign an EIP. </p>
<p id="eip_api_0001__en-us_topic_0201534274_p1672020513451">The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, load balancers, and NAT gateways. </p>
</div>
<div class="section" id="eip_api_0001__en-us_topic_0201534274_section42271171"><h4 class="sectiontitle">URI</h4><p id="eip_api_0001__en-us_topic_0201534274_p1262403912113">POST /v1/{project_id}/publicips</p>
<div class="p" id="eip_api_0001__en-us_topic_0201534274_p9418161619376"><a href="#eip_api_0001__en-us_topic_0201534274_table57311924">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_api_0001__en-us_topic_0201534274_table57311924"></a><a name="en-us_topic_0201534274_table57311924"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table57311924" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row11854613"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p20699582">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p66053444">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p48728718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row54712068"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p2492560">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p570775">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p10487112">Specifies the project ID. </p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_api_0001__en-us_topic_0201534274_section44896221"><h4 class="sectiontitle">Request Message</h4><ul id="eip_api_0001__en-us_topic_0201534274_ul53872188"><li id="eip_api_0001__en-us_topic_0201534274_li14140023">Request parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table62031189151043" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row4339910151043"><th align="left" class="cellrowborder" valign="top" width="14.280000000000001%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p15988448151043">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p19995902151043">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p9055369151043">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.18%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="eip_api_0001__en-us_topic_0201534274_p62396264151043">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row20932612151043"><td class="cellrowborder" valign="top" width="14.280000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p17819972151043">publicip</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p34131600151043">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p13196241151043"><a href="#eip_api_0001__en-us_topic_0201534274_table4491214">publicip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="eip_api_0001__en-us_topic_0201534274_p23492844151043">Specifies the EIP object. For details, see <a href="#eip_api_0001__en-us_topic_0201534274_table4491214">Table 3</a>.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row13560713151050"><td class="cellrowborder" valign="top" width="14.280000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p24675975151050">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p52596998151050">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p12429959151120"><a href="#eip_api_0001__en-us_topic_0201534274_table11041789">bandwidth</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="eip_api_0001__en-us_topic_0201534274_p1744019151120">Specifies the bandwidth object. For details, see <a href="#eip_api_0001__en-us_topic_0201534274_table11041789">Table 4</a>.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row7563161315419"><td class="cellrowborder" valign="top" width="14.280000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p19564181313543">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p13564413185412">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p95641133547">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul16411048123"><li id="eip_api_0001__en-us_topic_0201534274_li166411481126">Specifies the enterprise project ID. The value is <strong id="eip_api_0001__en-us_topic_0201534274_b2079912184376">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="eip_api_0001__en-us_topic_0201534274_li1964134819210">When you assign an EIP, associate an enterprise project ID with the EIP.</li><li id="eip_api_0001__en-us_topic_0201534274_li138471820104119">If this parameter is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_b4972117202413">0</strong>, which indicates that the default enterprise project is used.</li></ul>
<div class="note" id="eip_api_0001__en-us_topic_0201534274_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="eip_api_0001__en-us_topic_0201534274_p621005831513">
<div class="tablenoborder"><a name="eip_api_0001__en-us_topic_0201534274_table4491214"></a><a name="en-us_topic_0201534274_table4491214"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table4491214" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_api_0001__en-us_topic_0201534274_b419064591915">publicip</strong> field</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row21610982"><th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.3.2.1.2.1.2.5.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p5659087">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.3.2.1.2.1.2.5.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p55732864">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.05%" id="mcps1.3.3.2.1.2.1.2.5.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p4226242618129">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.3.2.1.2.1.2.5.1.4"><p id="eip_api_0001__en-us_topic_0201534274_p18068130">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row54232412"><td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p30749271">type</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p7663035">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p70444218129">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul29589093174724"><li id="eip_api_0001__en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_api_0001__en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_api_0001__en-us_topic_0201534274_b181284247819">5_bgp</strong> (Dynamic BGP), <strong id="eip_api_0001__en-us_topic_0201534274_b8210926387">5_mailbgp</strong> (Mail BGP), or <strong id="eip_api_0001__en-us_topic_0201534274_b1488422919816">5_gray</strong> (Dedicated load balancer, shared load balancer).</li><li id="eip_api_0001__en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_api_0001__en-us_topic_0201534274_ul9738153015499"><li id="eip_api_0001__en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_api_0001__en-us_topic_0201534274_li92181231912"><strong id="eip_api_0001__en-us_topic_0201534274_b1719710451843">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0001__en-us_topic_0201534274_b12742834164313">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_b1222755015432">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row116305209446"><td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p25480789446">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p50677729446">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p78364279446">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul3888143018611"><li id="eip_api_0001__en-us_topic_0201534274_li7888193015610">Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it.</li><li id="eip_api_0001__en-us_topic_0201534274_li188863011614">The value must be a valid IPv4 address in the available IP address range.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="eip_api_0001__en-us_topic_0201534274_table11041789"></a><a name="en-us_topic_0201534274_table11041789"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table11041789" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="eip_api_0001__en-us_topic_0201534274_b124532514229">bandwidth</strong> field</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row60677888"><th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p15961928">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.10828917108289%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p17847776">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p3784029918155">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.886911308869113%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="eip_api_0001__en-us_topic_0201534274_p36383728">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row61400865"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p7414170">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p63676932">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p4516535118155">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul518119181073"><li id="eip_api_0001__en-us_topic_0201534274_li1818011815719">Specifies the bandwidth name.</li><li id="eip_api_0001__en-us_topic_0201534274_li131809185719">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li><li id="eip_api_0001__en-us_topic_0201534274_li118019181872">This parameter is mandatory when <strong id="eip_api_0001__en-us_topic_0201534274_b276165742195527">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b1379441107195527">PER</strong>. This parameter will be ignored when <strong id="eip_api_0001__en-us_topic_0201534274_b1701699234195527">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b1218397550195527">WHOLE</strong> with an ID specified.</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row15772917"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p2537905">size</p>
</td>
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p4243749">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p3451484018155">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul194366475712"><li id="eip_api_0001__en-us_topic_0201534274_li543616474717">Specifies the bandwidth size.</li><li id="eip_api_0001__en-us_topic_0201534274_li443617471974">The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (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.)</li><li id="eip_api_0001__en-us_topic_0201534274_li174360479716">This parameter is mandatory when <strong id="eip_api_0001__en-us_topic_0201534274_b2144584290">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b1017608721">PER</strong>. This parameter will be ignored when <strong id="eip_api_0001__en-us_topic_0201534274_b633247722">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b1300325058">WHOLE</strong> with an ID specified.</li><li id="eip_api_0001__en-us_topic_0201534274_li196416519717">The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:<ul id="eip_api_0001__en-us_topic_0201534274_ul9790510185"><li id="eip_api_0001__en-us_topic_0201534274_li117904102081">The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).</li><li id="eip_api_0001__en-us_topic_0201534274_li779011105810">The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).</li><li id="eip_api_0001__en-us_topic_0201534274_li147907100814">The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row42186470"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p61660876">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p28475059">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p4423869418155">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul569842518819"><li id="eip_api_0001__en-us_topic_0201534274_li6698725880">Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.</li><li id="eip_api_0001__en-us_topic_0201534274_li8698825689">The value can be the ID of the shared bandwidth whose type is set to <strong>WHOLE</strong>.</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row33642107"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p40656116">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p4811061">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p2656447218155">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul2255712095"><li id="eip_api_0001__en-us_topic_0201534274_li152514111893">Specifies the bandwidth type.</li><li id="eip_api_0001__en-us_topic_0201534274_li13255611092">Possible values are as follows:<ul id="eip_api_0001__en-us_topic_0201534274_ul143257017559"><li id="eip_api_0001__en-us_topic_0201534274_li438892217508"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706204716">PER</strong>: Dedicated bandwidth</li><li id="eip_api_0001__en-us_topic_0201534274_li7419195317498"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706204729">WHOLE</strong>: Shared bandwidth</li></ul>
</li><li id="eip_api_0001__en-us_topic_0201534274_li6910185114583">If this parameter is set to <strong id="eip_api_0001__en-us_topic_0201534274_b332671121913">WHOLE</strong>, the bandwidth ID must be specified.</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row17737188172319"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p27426113172319">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p55776100172330">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p23864764172319">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul152417331215"><li id="eip_api_0001__en-us_topic_0201534274_li539713239139">The value is <strong id="eip_api_0001__en-us_topic_0201534274_b842352706173820">traffic</strong>, indicating that the billing is based on traffic.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_api_0001__en-us_topic_0201534274_ul4600869594349"><li id="eip_api_0001__en-us_topic_0201534274_li1142507994349">Example request (IPv4 EIP with dedicated bandwidth)<pre class="screen" id="eip_api_0001__en-us_topic_0201534274_screen56409399144156">POST https://{Endpoint}/v1/{project_id}/publicips
{
"publicip": {
"type": "5_bgp",
"ip_version": 4
},
"bandwidth": {
"name": "bandwidth123",
"size": 10,
"share_type": "PER"
},
"enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0001__en-us_topic_0201534274_section1412808"><h4 class="sectiontitle">Response Message</h4><ul id="eip_api_0001__en-us_topic_0201534274_ul14684604"><li id="eip_api_0001__en-us_topic_0201534274_li34767408">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table32663367152049" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row49418185152049"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p43450028152049">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p64289235152049">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p40045543152049">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row22463580152049"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p7610714152049">publicip</p>
</td>
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p4900878152049"><a href="#eip_api_0001__en-us_topic_0201534274_table44471219">publicip</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p15970624152049">Specifies the EIP object. For details, see <a href="#eip_api_0001__en-us_topic_0201534274_table44471219">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0001__en-us_topic_0201534274_table44471219"></a><a name="en-us_topic_0201534274_table44471219"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0001__en-us_topic_0201534274_table44471219" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong>publicip</strong> field</caption><thead align="left"><tr id="eip_api_0001__en-us_topic_0201534274_row33860402"><th align="left" class="cellrowborder" valign="top" width="37.96379637963796%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="eip_api_0001__en-us_topic_0201534274_p58338056">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.072407240724072%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="eip_api_0001__en-us_topic_0201534274_p4133121218330">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.96379637963796%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="eip_api_0001__en-us_topic_0201534274_p34137829">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0001__en-us_topic_0201534274_row13700797"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p36022757">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p5949386218330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p25236858">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row25805135"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p9841225">status</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p5427353718330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0001__en-us_topic_0201534274_ul052132731516"><li id="eip_api_0001__en-us_topic_0201534274_li747202719153">Specifies the <span id="eip_api_0001__en-us_topic_0201534274_text326151981">EIP</span><span id="eip_api_0001__en-us_topic_0201534274_text12611120818"></span> status.</li><li id="eip_api_0001__en-us_topic_0201534274_li2493271158">Possible values are as follows:<ul id="eip_api_0001__en-us_topic_0201534274_ul10603143175810"><li id="eip_api_0001__en-us_topic_0201534274_li2061882375415"><strong id="eip_api_0001__en-us_topic_0201534274_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_api_0001__en-us_topic_0201534274_li9516132714542"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181622">BIND_ERROR</strong> (Binding failed)</li><li id="eip_api_0001__en-us_topic_0201534274_li142101130195412"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181646">BINDING</strong> (Binding)</li><li id="eip_api_0001__en-us_topic_0201534274_li18886123225416"><strong id="eip_api_0001__en-us_topic_0201534274_b84235270618176">PENDING_DELETE</strong> (Releasing)</li><li id="eip_api_0001__en-us_topic_0201534274_li18843635415"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181716">PENDING_CREATE</strong> (Assigning)</li><li id="eip_api_0001__en-us_topic_0201534274_li1197744545418"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181818">PENDING_UPDATE</strong> (Updating)</li><li id="eip_api_0001__en-us_topic_0201534274_li19952124945414"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181834">DOWN</strong> (Unbound)</li><li id="eip_api_0001__en-us_topic_0201534274_li13389115319543"><strong id="eip_api_0001__en-us_topic_0201534274_b84235270610164">ACTIVE</strong> (Bound)</li><li id="eip_api_0001__en-us_topic_0201534274_li1572075905417"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706181859">ELB</strong> (Bound to a load balancer)</li><li id="eip_api_0001__en-us_topic_0201534274_li568520392305"><strong id="eip_api_0001__en-us_topic_0201534274_b842352706103022">ERROR</strong> (Exceptions)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row66476022"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p1332417268438">type</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p3408038918330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0001__en-us_topic_0201534274_ul61069400416"><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b181284247819">5_bgp</strong> (Dynamic BGP), <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b8210926387">5_mailbgp</strong> (Mail BGP), or <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b1488422919816">5_gray</strong> (Dedicated load balancer, shared load balancer).</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_ul9738153015499"><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_li92181231912"><strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b1719710451843">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b12742834164313">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b1222755015432">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row53754023"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p59108624">public_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p904808818330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p40237373">Specifies the obtained EIP if only IPv4 EIPs are available.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row58647356212"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p171101456172118">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p1811012569218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p1211011564217">Specifies the IP address version. The value can be <strong id="eip_api_0001__en-us_topic_0201534274_b842352706115744">4</strong> or <strong id="eip_api_0001__en-us_topic_0201534274_b842352706115748">6</strong>.</p>
<ul id="eip_api_0001__en-us_topic_0201534274_ul13987110227"><li id="eip_api_0001__en-us_topic_0201534274_li998813101125"><strong id="eip_api_0001__en-us_topic_0201534274_b1375121543213">4</strong>: IPv4</li><li id="eip_api_0001__en-us_topic_0201534274_li45811172214"><strong id="eip_api_0001__en-us_topic_0201534274_b1820584312112">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row26592044"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p6471942">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p6180656518330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p17634333267">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row43875021"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p64215808">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p4027585818330">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p27139175">Specifies the time (UTC) when the EIP is assigned.</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row42925989"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p54453050">bandwidth_size</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p4111904718330">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p11161650">Specifies the bandwidth (Mbit/s).</p>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row59251766137"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p4160981130">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p201633831312">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0001__en-us_topic_0201534274_ul11996131168"><li id="eip_api_0001__en-us_topic_0201534274_li1519914138168">Specifies the enterprise project ID. The value is <strong id="eip_api_0001__en-us_topic_0201534274_b44281320203816">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="eip_api_0001__en-us_topic_0201534274_li181991113161611">When you assign an EIP, associate an enterprise project ID with the EIP.</li><li id="eip_api_0001__en-us_topic_0201534274_li693561319371">If this parameter is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b4972117202413">0</strong>, which indicates that the default enterprise project is used.</li></ul>
<div class="note" id="eip_api_0001__en-us_topic_0201534274_note1296911912553"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534275_p182751511487_1">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="eip_api_0001__en-us_topic_0201534274_li5819955994414">Example response (IPv4 EIP with dedicated bandwidth)<pre class="screen" id="eip_api_0001__en-us_topic_0201534274_screen4965500714423">{
"publicip": {
"id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
"status": "PENDING_CREATE",
"type": "5_bgp",
"public_ip_address": "161.xx.xx.7",
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"ip_version": 4,
"create_time": "2015-07-16 04:10:52",
"bandwidth_size": 0,
"enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0001__en-us_topic_0201534274_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_api_0001__en-us_topic_0201534274_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_api_0001__en-us_topic_0201534274_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_api_0001__en-us_topic_0201534274_p7233105282813">See <a href="eip_api05_0002.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="eip_api_0000.html">Elastic IP</a></div>
</div>
</div>
View Git Blame Copy Permalink