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 65b77b76d4 EIP API 20230106 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2023-08-01 06:58:15 +00:00

313 lines
39 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 <span id="eip_api_0001__en-us_topic_0201534274_text371189191112">ECS</span>s, <span id="eip_api_0001__en-us_topic_0201534274_text17715921119">BMS</span>s, virtual IP addresses, NAT gateways, or load balancers. </p>
<div class="note" id="eip_api_0001__en-us_topic_0201534274_note1672091317360"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b1958731314398">5_gray</strong>) type:<ul id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_ul18141507494"><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li86521438154">In <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b108739322183">5_gray</strong>) type cannot be assigned anymore. You can assign EIPs of the BGP (<strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b113526330389">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_ul2044703613155"><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_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="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li15559236131711">EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li1659819163617">You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.</li></ul>
</li><li id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0118498850_b354915453512">5_gray</strong>) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.</li></ul>
</div>
</div></div>
</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 Parameters</h4>
<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 body 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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_api_0001__en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</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_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0001__en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0001__en-us_topic_0201534274_row4771536182914"><td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.3.1.2.5.1.1 "><p id="eip_api_0001__en-us_topic_0201534274_p1661484872917">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.3.1.2.5.1.2 "><p id="eip_api_0001__en-us_topic_0201534274_p1861404882912">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.3.3.1.2.5.1.3 "><p id="eip_api_0001__en-us_topic_0201534274_p1661413481295">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.3.1.2.5.1.4 "><ul id="eip_api_0001__en-us_topic_0201534274_ul1842191914615"><li id="eip_api_0001__en-us_topic_0201534274_li38863441812">Specifies the <span id="eip_api_0001__en-us_topic_0201534274_text26315543314"></span><span id="eip_api_0001__en-us_topic_0201534274_text106312548310">EIP</span> version.</li><li id="eip_api_0001__en-us_topic_0201534274_li188184199591">The value can be <strong id="eip_api_0001__en-us_topic_0201534274_b145038516563">4</strong> and <strong id="eip_api_0001__en-us_topic_0201534274_b892145617567">6</strong>, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.</li><li id="eip_api_0001__en-us_topic_0201534274_li1242699174711">Constraints:<ul id="eip_api_0001__en-us_topic_0201534274_ul1190139775"><li id="eip_api_0001__en-us_topic_0201534274_li16190839777">The configured value must be supported by the system. </li><li id="eip_api_0001__en-us_topic_0201534274_li1919016391072">If this parameter is left blank or is an empty string, IPv4 address is created by default.</li></ul>
</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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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_b1821532961">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b1490781454">PER</strong>. This parameter will be ignored when <strong id="eip_api_0001__en-us_topic_0201534274_b1699836229">share_type</strong> is set to <strong id="eip_api_0001__en-us_topic_0201534274_b139603302">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.4.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.4.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.4.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.4.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 id="eip_api_0001__en-us_topic_0201534274_b437419315012">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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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>
<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 id="eip_api_0001__en-us_topic_0201534274_b15379838502">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"></span><span id="eip_api_0001__en-us_topic_0201534274_text12611120818">EIP</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_li1487831953011"><strong id="eip_api_0001__en-us_topic_0201534274_b178834259448">NOTIFYING</strong> (Assigning)</li><li id="eip_api_0001__en-us_topic_0201534274_li1919318493119"><strong id="eip_api_0001__en-us_topic_0201534274_b6838173144614">NOTIFY_DELETE</strong> (Release)</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_li161441845132911"><strong id="eip_api_0001__en-us_topic_0201534274_b1178620419135">VPN</strong> (Bound to a VPN)</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_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</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_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0001__en-us_topic_0201534274_en-us_topic_0201534274_b819152812216">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="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="eip_api_0000.html">EIP</a></div>
</div>
</div>
View Git Blame Copy Permalink