forked from docs/doc-exports
fanqinying
05458809ab
Reviewed-by: Szirovicza Gergő <a94652429@noreply.gitea.eco.tsi-dev.otc-service.com> Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: fanqinying <fanqinying@huawei.com> Co-committed-by: fanqinying <fanqinying@huawei.com>
332 lines
36 KiB
HTML
332 lines
36 KiB
HTML
<a name="en-us_topic_0020090596"></a><a name="en-us_topic_0020090596"></a>
|
|
|
|
<h1 class="topictitle1">Assigning an EIP </h1>
|
|
<div id="body8414476"><div class="section" id="en-us_topic_0020090596__section12153337"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0020090596__p10483995">This API is used to assign an EIP. </p>
|
|
<p id="en-us_topic_0020090596__p1672020513451">The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be flexibly bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers. </p>
|
|
<div class="note" id="en-us_topic_0020090596__note13848133064014"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="en-us_topic_0020090596__vpc_floatingip_0001_p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="en-us_topic_0020090596__vpc_floatingip_0001_b207851911124910">5_gray</strong>) type:<ul id="en-us_topic_0020090596__vpc_floatingip_0001_ul18141507494"><li id="en-us_topic_0020090596__vpc_floatingip_0001_li86521438154">In <strong id="en-us_topic_0020090596__vpc_floatingip_0001_b1135821505214">eu-de</strong>, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (<strong id="en-us_topic_0020090596__vpc_floatingip_0001_b3358161545217">5_bgp</strong>) type.</li><li id="en-us_topic_0020090596__vpc_floatingip_0001_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="en-us_topic_0020090596__vpc_floatingip_0001_b1093341819529">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="en-us_topic_0020090596__vpc_floatingip_0001_ul2044703613155"><li id="en-us_topic_0020090596__vpc_floatingip_0001_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="en-us_topic_0020090596__vpc_floatingip_0001_li1688013347356">You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html" target="_blank" rel="noopener noreferrer">Binding an EIP</a> and <a href="https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html" target="_blank" rel="noopener noreferrer">Unbinding an EIP</a>.</li><li id="en-us_topic_0020090596__vpc_floatingip_0001_li15559236131711">EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.</li><li id="en-us_topic_0020090596__vpc_floatingip_0001_li1659819163617">You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.</li></ul>
|
|
</li><li id="en-us_topic_0020090596__vpc_floatingip_0001_li1468695512506"><strong id="en-us_topic_0020090596__vpc_floatingip_0001_b11943176165312">5_gray</strong> EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.</li></ul>
|
|
</div>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section42271171"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0020090596__p1262403912113">POST /v1/{project_id}/publicips</p>
|
|
<div class="p" id="en-us_topic_0020090596__p9418161619376"><a href="#en-us_topic_0020090596__table57311924">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="en-us_topic_0020090596__table57311924"></a><a name="table57311924"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table57311924" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0020090596__row11854613"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="en-us_topic_0020090596__p20699582">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="en-us_topic_0020090596__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="en-us_topic_0020090596__p48728718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row54712068"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="en-us_topic_0020090596__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="en-us_topic_0020090596__p570775">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="en-us_topic_0020090596__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section44896221"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table62031189151043" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="en-us_topic_0020090596__row4339910151043"><th align="left" class="cellrowborder" valign="top" width="14.280000000000001%" id="mcps1.3.3.2.2.5.1.1"><p id="en-us_topic_0020090596__p15988448151043">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.2.2.5.1.2"><p id="en-us_topic_0020090596__p19995902151043">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.3.2.2.5.1.3"><p id="en-us_topic_0020090596__p9055369151043">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.18%" id="mcps1.3.3.2.2.5.1.4"><p id="en-us_topic_0020090596__p62396264151043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row20932612151043"><td class="cellrowborder" valign="top" width="14.280000000000001%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0020090596__p17819972151043">publicip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en-us_topic_0020090596__p34131600151043">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0020090596__p13196241151043"><a href="#en-us_topic_0020090596__table4491214">publicip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en-us_topic_0020090596__p23492844151043">Specifies the EIP object. For details, see <a href="#en-us_topic_0020090596__table4491214">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row13560713151050"><td class="cellrowborder" valign="top" width="14.280000000000001%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0020090596__p24675975151050">bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en-us_topic_0020090596__p52596998151050">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0020090596__p12429959151120"><a href="#en-us_topic_0020090596__table11041789">bandwidth</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en-us_topic_0020090596__p1744019151120">Specifies the bandwidth object. For details, see <a href="#en-us_topic_0020090596__table11041789">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="p" id="en-us_topic_0020090596__p621005831513">
|
|
<div class="tablenoborder"><a name="en-us_topic_0020090596__table4491214"></a><a name="table4491214"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table4491214" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="en-us_topic_0020090596__b419064591915">publicip</strong> field</caption><thead align="left"><tr id="en-us_topic_0020090596__row21610982"><th align="left" class="cellrowborder" valign="top" width="15.160000000000002%" id="mcps1.3.3.3.1.2.5.1.1"><p id="en-us_topic_0020090596__p5659087">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.009999999999998%" id="mcps1.3.3.3.1.2.5.1.2"><p id="en-us_topic_0020090596__p55732864">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.08%" id="mcps1.3.3.3.1.2.5.1.3"><p id="en-us_topic_0020090596__p4226242618129">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.75%" id="mcps1.3.3.3.1.2.5.1.4"><p id="en-us_topic_0020090596__p18068130">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row54232412"><td class="cellrowborder" valign="top" width="15.160000000000002%" headers="mcps1.3.3.3.1.2.5.1.1 "><p id="en-us_topic_0020090596__p30749271">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.3.3.1.2.5.1.2 "><p id="en-us_topic_0020090596__p7663035">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.3.3.1.2.5.1.3 "><p id="en-us_topic_0020090596__p70444218129">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.3.3.1.2.5.1.4 "><ul id="en-us_topic_0020090596__ul29589093174724"><li id="en-us_topic_0020090596__li085013408491">Specifies the EIP type.</li><li id="en-us_topic_0020090596__li95615391617">The value can be <strong id="en-us_topic_0020090596__b236112814388">5_bgp</strong> (Dynamic BGP), <strong id="en-us_topic_0020090596__b11267530143818">5_mailbgp</strong> (Mail BGP), <strong id="en-us_topic_0020090596__b14236103853812">5_gray</strong> (Dedicated Load Balancer), or <strong id="en-us_topic_0020090596__b126941113194811">5_dualStack</strong>.</li><li id="en-us_topic_0020090596__li2979182764911">Constraints:<ul id="en-us_topic_0020090596__ul9738153015499"><li id="en-us_topic_0020090596__li1385054094914">The configured value must be supported by the system. </li><li id="en-us_topic_0020090596__li92181231912"><strong id="en-us_topic_0020090596__b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="en-us_topic_0020090596__b960162813315">publicip_type</strong> is not specified, the default value is <strong id="en-us_topic_0020090596__b184991818937">5_bgp</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row4771536182914"><td class="cellrowborder" valign="top" width="15.160000000000002%" headers="mcps1.3.3.3.1.2.5.1.1 "><p id="en-us_topic_0020090596__p1661484872917">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.3.3.1.2.5.1.2 "><p id="en-us_topic_0020090596__p1861404882912">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.3.3.1.2.5.1.3 "><p id="en-us_topic_0020090596__p1661413481295">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.3.3.1.2.5.1.4 "><ul id="en-us_topic_0020090596__ul1842191914615"><li id="en-us_topic_0020090596__li38863441812">Specifies the <span id="en-us_topic_0020090596__text26315543314"></span><span id="en-us_topic_0020090596__text106312548310">EIP</span> version.</li><li id="en-us_topic_0020090596__li188184199591">The value can be <strong id="en-us_topic_0020090596__b145038516563">4</strong> and <strong id="en-us_topic_0020090596__b892145617567">6</strong>, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.</li><li id="en-us_topic_0020090596__li1242699174711">Constraints:<ul id="en-us_topic_0020090596__ul1190139775"><li id="en-us_topic_0020090596__li16190839777">The configured value must be supported by the system. </li><li id="en-us_topic_0020090596__li1919016391072">If this parameter is left blank or is an empty string, IPv4 address is created by default.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row1083214140109"><td class="cellrowborder" valign="top" width="15.160000000000002%" headers="mcps1.3.3.3.1.2.5.1.1 "><p id="en-us_topic_0020090596__p19833814131013">alias</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.009999999999998%" headers="mcps1.3.3.3.1.2.5.1.2 "><p id="en-us_topic_0020090596__p2083301414101">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.08%" headers="mcps1.3.3.3.1.2.5.1.3 "><p id="en-us_topic_0020090596__p1883381418108">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.75%" headers="mcps1.3.3.3.1.2.5.1.4 "><ul id="en-us_topic_0020090596__ul17228652131119"><li id="en-us_topic_0020090596__li15228185215118">Specifies the EIP name.</li><li id="en-us_topic_0020090596__li1722865261114">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0020090596__table11041789"></a><a name="table11041789"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table11041789" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="en-us_topic_0020090596__b124532514229">bandwidth</strong> field</caption><thead align="left"><tr id="en-us_topic_0020090596__row60677888"><th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.3.4.2.5.1.1"><p id="en-us_topic_0020090596__p15961928">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.10828917108289%" id="mcps1.3.3.4.2.5.1.2"><p id="en-us_topic_0020090596__p17847776">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.3.4.2.5.1.3"><p id="en-us_topic_0020090596__p3784029918155">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.886911308869113%" id="mcps1.3.3.4.2.5.1.4"><p id="en-us_topic_0020090596__p36383728">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row61400865"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0020090596__p7414170">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0020090596__p63676932">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0020090596__p4516535118155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="en-us_topic_0020090596__ul518119181073"><li id="en-us_topic_0020090596__li1818011815719">Specifies the bandwidth name.</li><li id="en-us_topic_0020090596__li131809185719">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li><li id="en-us_topic_0020090596__li118019181872">This parameter is mandatory when <strong id="en-us_topic_0020090596__b276165742195527">share_type</strong> is set to <strong id="en-us_topic_0020090596__b1379441107195527">PER</strong>. This parameter will be ignored when <strong id="en-us_topic_0020090596__b1701699234195527">share_type</strong> is set to <strong id="en-us_topic_0020090596__b1218397550195527">WHOLE</strong> with an ID specified.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row15772917"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0020090596__p2537905">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0020090596__p4243749">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0020090596__p3451484018155">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="en-us_topic_0020090596__ul194366475712"><li id="en-us_topic_0020090596__li543616474717">Specifies the bandwidth size.</li><li id="en-us_topic_0020090596__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="en-us_topic_0020090596__li174360479716">This parameter is mandatory when <strong id="en-us_topic_0020090596__b2074544163">share_type</strong> is set to <strong id="en-us_topic_0020090596__b280690614">PER</strong>. This parameter will be ignored when <strong id="en-us_topic_0020090596__b1663049647">share_type</strong> is set to <strong id="en-us_topic_0020090596__b239876333">WHOLE</strong> with an ID specified.</li><li id="en-us_topic_0020090596__li196416519717">The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:<ul id="en-us_topic_0020090596__ul9790510185"><li id="en-us_topic_0020090596__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="en-us_topic_0020090596__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="en-us_topic_0020090596__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="en-us_topic_0020090596__row42186470"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0020090596__p61660876">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0020090596__p28475059">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0020090596__p4423869418155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="en-us_topic_0020090596__ul569842518819"><li id="en-us_topic_0020090596__li6698725880">Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.</li><li id="en-us_topic_0020090596__li8698825689">The value can be the ID of the shared bandwidth whose type is set to <strong id="en-us_topic_0020090596__b437419315012">WHOLE</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row33642107"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0020090596__p40656116">share_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0020090596__p4811061">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0020090596__p2656447218155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="en-us_topic_0020090596__ul2255712095"><li id="en-us_topic_0020090596__li152514111893">Specifies the bandwidth type.</li><li id="en-us_topic_0020090596__li13255611092">Range:<ul id="en-us_topic_0020090596__ul143257017559"><li id="en-us_topic_0020090596__li438892217508"><strong id="en-us_topic_0020090596__b842352706204716">PER</strong>: Dedicated bandwidth</li><li id="en-us_topic_0020090596__li7419195317498"><strong id="en-us_topic_0020090596__b842352706204729">WHOLE</strong>: Shared bandwidth</li></ul>
|
|
</li><li id="en-us_topic_0020090596__li6910185114583">If this parameter is set to <strong id="en-us_topic_0020090596__b332671121913">WHOLE</strong>, the bandwidth ID must be specified.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row17737188172319"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0020090596__p27426113172319">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0020090596__p55776100172330">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0020090596__p23864764172319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.886911308869113%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="en-us_topic_0020090596__ul152417331215"><li id="en-us_topic_0020090596__li192411321215">Specifies whether the bandwidth is billed by traffic or by bandwidth size.</li><li id="en-us_topic_0020090596__li539713239139">The value is <strong id="en-us_topic_0020090596__b842352706173820">traffic</strong>, indicating that the billing is based on traffic.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section8383114210299"><h4 class="sectiontitle">Example Request</h4><div class="p" id="en-us_topic_0020090596__p519707305">Example request (IPv4 EIP with dedicated bandwidth)<pre class="screen" id="en-us_topic_0020090596__screen56409399144156">POST https://{Endpoint}/v1/{project_id}/publicips
|
|
|
|
{
|
|
"publicip": {
|
|
"type": "5_bgp",
|
|
"ip_version": 4
|
|
},
|
|
"bandwidth": {
|
|
"name": "bandwidth123",
|
|
"size": 10,
|
|
"share_type": "PER"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section1412808"><h4 class="sectiontitle">Response Message</h4><ul id="en-us_topic_0020090596__ul14684604"><li id="en-us_topic_0020090596__li34767408">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table32663367152049" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0020090596__row49418185152049"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="en-us_topic_0020090596__p43450028152049">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="en-us_topic_0020090596__p64289235152049">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="en-us_topic_0020090596__p40045543152049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row22463580152049"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="en-us_topic_0020090596__p7610714152049">publicip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="en-us_topic_0020090596__p4900878152049"><a href="#en-us_topic_0020090596__table44471219">publicip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="en-us_topic_0020090596__p15970624152049">Specifies the EIP object. For details, see <a href="#en-us_topic_0020090596__table44471219">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0020090596__table44471219"></a><a name="table44471219"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0020090596__table44471219" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="en-us_topic_0020090596__b15379838502">publicip</strong> field</caption><thead align="left"><tr id="en-us_topic_0020090596__row33860402"><th align="left" class="cellrowborder" valign="top" width="37.96379637963796%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="en-us_topic_0020090596__p58338056">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.072407240724072%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="en-us_topic_0020090596__p4133121218330">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.96379637963796%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="en-us_topic_0020090596__p34137829">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0020090596__row13700797"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p36022757">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p5949386218330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p25236858">Specifies the unique identifier of an EIP.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row25805135"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p9841225">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p5427353718330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="en-us_topic_0020090596__ul052132731516"><li id="en-us_topic_0020090596__li747202719153">Specifies the <span id="en-us_topic_0020090596__text326151981"></span><span id="en-us_topic_0020090596__text12611120818">EIP</span> status.</li><li id="en-us_topic_0020090596__li2493271158">Range:<ul id="en-us_topic_0020090596__ul10603143175810"><li id="en-us_topic_0020090596__li2061882375415"><strong id="en-us_topic_0020090596__b84235270610153">FREEZED</strong> (Frozen)</li><li id="en-us_topic_0020090596__li9516132714542"><strong id="en-us_topic_0020090596__b842352706181622">BIND_ERROR</strong> (Binding failed)</li><li id="en-us_topic_0020090596__li142101130195412"><strong id="en-us_topic_0020090596__b842352706181646">BINDING</strong> (Binding)</li><li id="en-us_topic_0020090596__li18886123225416"><strong id="en-us_topic_0020090596__b84235270618176">PENDING_DELETE</strong> (Releasing)</li><li id="en-us_topic_0020090596__li18843635415"><strong id="en-us_topic_0020090596__b842352706181716">PENDING_CREATE</strong> (Assigning)</li><li id="en-us_topic_0020090596__li1197744545418"><strong id="en-us_topic_0020090596__b842352706181818">PENDING_UPDATE</strong> (Updating)</li><li id="en-us_topic_0020090596__li1487831953011"><strong id="en-us_topic_0020090596__b178834259448">NOTIFYING</strong> (Assigning)</li><li id="en-us_topic_0020090596__li1919318493119"><strong id="en-us_topic_0020090596__b6838173144614">NOTIFY_DELETE</strong> (Release)</li><li id="en-us_topic_0020090596__li19952124945414"><strong id="en-us_topic_0020090596__b842352706181834">DOWN</strong> (Unbound)</li><li id="en-us_topic_0020090596__li13389115319543"><strong id="en-us_topic_0020090596__b84235270610164">ACTIVE</strong> (Bound)</li><li id="en-us_topic_0020090596__li1572075905417"><strong id="en-us_topic_0020090596__b842352706181859">ELB</strong> (Bound to a load balancer)</li><li id="en-us_topic_0020090596__li161441845132911"><strong id="en-us_topic_0020090596__b1178620419135">VPN</strong> (Bound to a VPN)</li><li id="en-us_topic_0020090596__li568520392305"><strong id="en-us_topic_0020090596__b842352706103022">ERROR</strong> (Exceptions)</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row66476022"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p1332417268438">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p3408038918330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="en-us_topic_0020090596__ul61069400416"><li id="en-us_topic_0020090596__en-us_topic_0020090596_li085013408491">Specifies the EIP type.</li><li id="en-us_topic_0020090596__en-us_topic_0020090596_li95615391617">The value can be <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b236112814388">5_bgp</strong> (Dynamic BGP), <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b11267530143818">5_mailbgp</strong> (Mail BGP), <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b14236103853812">5_gray</strong> (Dedicated Load Balancer), or <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b126941113194811">5_dualStack</strong>.</li><li id="en-us_topic_0020090596__en-us_topic_0020090596_li2979182764911">Constraints:<ul id="en-us_topic_0020090596__en-us_topic_0020090596_ul9738153015499"><li id="en-us_topic_0020090596__en-us_topic_0020090596_li1385054094914">The configured value must be supported by the system. </li><li id="en-us_topic_0020090596__en-us_topic_0020090596_li92181231912"><strong id="en-us_topic_0020090596__en-us_topic_0020090596_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b960162813315">publicip_type</strong> is not specified, the default value is <strong id="en-us_topic_0020090596__en-us_topic_0020090596_b184991818937">5_bgp</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row53754023"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p59108624">public_ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p904808818330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p40237373">Specifies the obtained EIP if only IPv4 EIPs are available.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row58647356212"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p171101456172118">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p1811012569218">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p1211011564217">Specifies the IP address version. The value can be <strong id="en-us_topic_0020090596__b842352706115744">4</strong> or <strong id="en-us_topic_0020090596__b842352706115748">6</strong>.</p>
|
|
<ul id="en-us_topic_0020090596__ul13987110227"><li id="en-us_topic_0020090596__li998813101125"><strong id="en-us_topic_0020090596__b1375121543213">4</strong>: IPv4</li><li id="en-us_topic_0020090596__li45811172214"><strong id="en-us_topic_0020090596__b1820584312112">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row26592044"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p6471942">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p6180656518330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p17634333267">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row43875021"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p64215808">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p4027585818330">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p27139175">Specifies the time (UTC) when the EIP is assigned.</p>
|
|
<p id="en-us_topic_0020090596__p1290634265710">Format: <em id="en-us_topic_0020090596__i1611456171410">yyyy-MM-dd HH:mm:ss</em></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row42925989"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p54453050">bandwidth_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p4111904718330">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p11161650">Specifies the bandwidth (Mbit/s).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row1048172571211"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p979842771215">alias</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p137987278128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p175531744191218">Specifies the EIP name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row59251766137"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p4160981130">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p201633831312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="en-us_topic_0020090596__ul11996131168"><li id="en-us_topic_0020090596__li1519914138168">Specifies the enterprise project ID. The value is <strong id="en-us_topic_0020090596__b44281320203816">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="en-us_topic_0020090596__li181991113161611">When you assign an EIP, associate an enterprise project ID with the EIP.</li><li id="en-us_topic_0020090596__li693561319371">If this parameter is not specified, the default value is <strong id="en-us_topic_0020090596__b92040189454">0</strong>, which indicates that the default enterprise project is used.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0020090596__row145577236592"><td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="en-us_topic_0020090596__p1388313292268">public_border_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.072407240724072%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="en-us_topic_0020090596__p118831329122611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.96379637963796%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="en-us_topic_0020090596__p29889336324">Specifies whether it is in a central site or an edge site.</p>
|
|
<p id="en-us_topic_0020090596__p20127195053611">Range:</p>
|
|
<ul id="en-us_topic_0020090596__ul1660185933618"><li id="en-us_topic_0020090596__vpc_sharebandwidth_0001_li761175917369">center</li><li id="en-us_topic_0020090596__vpc_sharebandwidth_0001_li1761759193615"><em id="en-us_topic_0020090596__i1498419353587">Edge site name</em></li></ul>
|
|
<p id="en-us_topic_0020090596__p65761507386">This resource can only be associated with an EIP of the same region.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section126872319307"><h4 class="sectiontitle">Example Response</h4><div class="p" id="en-us_topic_0020090596__p144471641153012">Example response (IPv4 EIP with dedicated bandwidth)<pre class="screen" id="en-us_topic_0020090596__screen4965500714423">{
|
|
"publicip": {
|
|
"id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
|
|
"alias": "tom",
|
|
"public_border_group": "center",
|
|
"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>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="en-us_topic_0020090596__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0020090596__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="en-us_topic_0020090596__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_eip_0000.html">EIP</a></div>
|
|
</div>
|
|
</div>
|
|
|