vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/eip/api-ref/eip_api_0004.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

307 lines
36 KiB
HTML
Raw Blame History

<a name="eip_api_0004"></a><a name="eip_api_0004"></a>
<h1 class="topictitle1">Updating an EIP</h1>
<div id="body8662426"><div class="section" id="eip_api_0004__en-us_topic_0201534286_section43589445"><h4 class="sectiontitle">Function</h4><p id="eip_api_0004__en-us_topic_0201534286_p36328474">This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.</p>
<div class="note" id="eip_api_0004__note18686528124513"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="eip_api_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_b1958731314398">5_gray</strong>) type:<ul id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_ul18141507494"><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_li86521438154">In <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_api_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_api_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_ul2044703613155"><li id="eip_api_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_en-us_topic_0201534274_en-us_topic_0118498850_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_api_0004__en-us_topic_0201534286_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_0004__en-us_topic_0201534286_section56760689"><h4 class="sectiontitle">URI</h4><p id="eip_api_0004__en-us_topic_0201534286_p1135789102812">PUT /v1/{project_id}/publicips/{publicip_id}</p>
<div class="p" id="eip_api_0004__en-us_topic_0201534286_p6161828163819"><a href="#eip_api_0004__en-us_topic_0201534286_table25231885">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_api_0004__en-us_topic_0201534286_table25231885"></a><a name="en-us_topic_0201534286_table25231885"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table25231885" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row34804713"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_api_0004__en-us_topic_0201534286_p609510">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_0004__en-us_topic_0201534286_p49370368">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_0004__en-us_topic_0201534286_p39576862">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row51609257"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p19600264">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_0004__en-us_topic_0201534286_p44117540">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_0004__en-us_topic_0201534286_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row16540805"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p64736823">publicip_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_0004__en-us_topic_0201534286_p9191297">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_0004__en-us_topic_0201534286_p6297612">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_api_0004__en-us_topic_0201534286_section41084157"><h4 class="sectiontitle">Request Message</h4><ul id="eip_api_0004__en-us_topic_0201534286_ul40344576"><li id="eip_api_0004__en-us_topic_0201534286_li17513507">Request parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table46814673152226" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row46264343152226"><th align="left" class="cellrowborder" valign="top" width="12.4%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="eip_api_0004__en-us_topic_0201534286_p56424328152226">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="eip_api_0004__en-us_topic_0201534286_p6967894152226">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="eip_api_0004__en-us_topic_0201534286_p27528552152226">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_0004__en-us_topic_0201534286_p15220263152226">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row24881786152226"><td class="cellrowborder" valign="top" width="12.4%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p2158794152226">publicip</p>
</td>
<td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p40644606152226">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p3878783152226"><a href="#eip_api_0004__en-us_topic_0201534286_table23403840">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_0004__en-us_topic_0201534286_p9060565152226">Specifies the EIP object. For details, see <a href="#eip_api_0004__en-us_topic_0201534286_table23403840">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0004__en-us_topic_0201534286_table23403840"></a><a name="en-us_topic_0201534286_table23403840"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table23403840" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_api_0004__en-us_topic_0201534286_b1047025614162">publicip</strong> field</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row4798296"><th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="eip_api_0004__en-us_topic_0201534286_p53117702">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.05%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="eip_api_0004__en-us_topic_0201534286_p7566645">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="eip_api_0004__en-us_topic_0201534286_p3809944218819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="eip_api_0004__en-us_topic_0201534286_p8918541">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row51313205"><td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p62728917">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p47877526">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p6615596018819">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_api_0004__en-us_topic_0201534286_ul1580299162914"><li id="eip_api_0004__en-us_topic_0201534286_li5802296295">Specifies the port ID.</li><li id="eip_api_0004__en-us_topic_0201534286_li1680209162911">The value must be an existing port ID. If this parameter is not included or the parameter value is left blank, the EIP is unbound. If the specified port ID does not exist or has already been bound with an EIP, an error message will be displayed. <p id="eip_api_0004__en-us_topic_0201534286_p18348444133019"><a name="eip_api_0004__en-us_topic_0201534286_li1680209162911"></a><a name="en-us_topic_0201534286_li1680209162911"></a>Leaving this parameter blank does not unbind the EIP from the dedicated load balancer.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="eip_api_0004__en-us_topic_0201534286_li10498294511">Example request 1 (Binding an EIP to a NIC)<pre class="screen" id="eip_api_0004__en-us_topic_0201534286_screen8268180144429">PUT https://{Endpoint}<em id="eip_api_0004__en-us_topic_0201534286_i59251527101312"><strong id="eip_api_0004__en-us_topic_0201534286_b9925102771311"></strong></em>/v1/{project_id}/publicips/{publicip_id}
{
"publicip": {
"port_id": "f588ccfa-8750-4d7c-bf5d-2ede24414706"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0004__en-us_topic_0201534286_section34213098"><h4 class="sectiontitle">Response Message</h4><ul id="eip_api_0004__en-us_topic_0201534286_ul23219884"><li id="eip_api_0004__en-us_topic_0201534286_li15861880">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table32985183152250" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row10178394152250"><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_0004__en-us_topic_0201534286_p19143548152250">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_0004__en-us_topic_0201534286_p40138407152250">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_0004__en-us_topic_0201534286_p29985535152250">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row12909284152250"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p39019069152250">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_0004__en-us_topic_0201534286_p50907501152250"><a href="#eip_api_0004__en-us_topic_0201534286_table83964341880">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_0004__en-us_topic_0201534286_p366643152250">Specifies the EIP object. For details, see <a href="#eip_api_0004__en-us_topic_0201534286_table83964341880">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0004__en-us_topic_0201534286_table83964341880"></a><a name="en-us_topic_0201534286_table83964341880"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table83964341880" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of the <strong id="eip_api_0004__en-us_topic_0201534286_b646922916449">publicips</strong> field</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row608739661880"><th align="left" class="cellrowborder" valign="top" width="36.046395360463954%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="eip_api_0004__en-us_topic_0201534286_p318442431880"><strong id="eip_api_0004__en-us_topic_0201534286_b1969533113447">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.90720927907209%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="eip_api_0004__en-us_topic_0201534286_p201897271880"><strong id="eip_api_0004__en-us_topic_0201534286_b0745256174410">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.046395360463954%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="eip_api_0004__en-us_topic_0201534286_p247551571880"><strong id="eip_api_0004__en-us_topic_0201534286_b19198155994410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row590107001880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p151373871880">id</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p623914921880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p205460611880">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row506968211880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p128018091880">status</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p394853281880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul263945115243"><li id="eip_api_0004__en-us_topic_0201534286_li15639135162419">Specifies the EIP status.</li><li id="eip_api_0004__en-us_topic_0201534286_li186392518245">Possible values are as follows:<ul id="eip_api_0004__en-us_topic_0201534286_ul7905205815810"><li id="eip_api_0004__en-us_topic_0201534286_li2057595210462"><strong id="eip_api_0004__en-us_topic_0201534286_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_api_0004__en-us_topic_0201534286_li45757527469"><strong id="eip_api_0004__en-us_topic_0201534286_b842352706181622">BIND_ERROR</strong> (Binding failed)</li><li id="eip_api_0004__en-us_topic_0201534286_li18575452164615"><strong id="eip_api_0004__en-us_topic_0201534286_b842352706181646">BINDING</strong> (Binding)</li><li id="eip_api_0004__en-us_topic_0201534286_li8575552154613"><strong id="eip_api_0004__en-us_topic_0201534286_b84235270618176">PENDING_DELETE</strong> (Releasing)</li><li id="eip_api_0004__en-us_topic_0201534286_li1857575215460"><strong id="eip_api_0004__en-us_topic_0201534286_b842352706181716">PENDING_CREATE</strong> (Assigning)</li><li id="eip_api_0004__en-us_topic_0201534286_li115755525461"><strong id="eip_api_0004__en-us_topic_0201534286_b842352706181818">PENDING_UPDATE</strong> (Updating)</li><li id="eip_api_0004__en-us_topic_0201534286_li1487831953011"><strong id="eip_api_0004__en-us_topic_0201534286_b195938151211">NOTIFYING</strong> (Assigning)</li><li id="eip_api_0004__en-us_topic_0201534286_li1919318493119"><strong id="eip_api_0004__en-us_topic_0201534286_b9410916125">NOTIFY_DELETE</strong> (Releasing)</li><li id="eip_api_0004__en-us_topic_0201534286_li19952124945414"><strong id="eip_api_0004__en-us_topic_0201534286_b2051681518122">DOWN</strong> (Unbound)</li><li id="eip_api_0004__en-us_topic_0201534286_li13389115319543"><strong id="eip_api_0004__en-us_topic_0201534286_b84235270610164">ACTIVE</strong> (Bound)</li><li id="eip_api_0004__en-us_topic_0201534286_li1572075905417"><strong id="eip_api_0004__en-us_topic_0201534286_b7170191718124">ELB</strong> (Bound to a load balancer)</li><li id="eip_api_0004__en-us_topic_0201534286_li161441845132911"><strong id="eip_api_0004__en-us_topic_0201534286_b239245581414">VPN</strong> (Bound to a VPN)</li><li id="eip_api_0004__en-us_topic_0201534286_li661175417182"><strong id="eip_api_0004__en-us_topic_0201534286_b842352706103022">ERROR</strong> (Exceptions)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row16130133562319"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p09743162419">profile</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p12971231132410"><a href="#eip_api_0004__en-us_topic_0201534286_table66651219193417">profile</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p5644118182514">Specifies the additional parameters, including the order ID and product ID. For details, see <a href="#eip_api_0004__en-us_topic_0201534286_table66651219193417">Table 6</a>.</p>
<p id="eip_api_0004__en-us_topic_0201534286_p1407131101719">This parameter is not supported currently.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row230260811880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p30749271">type</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p379401841880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul7176216121014"><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</li><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_ul9738153015499"><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_li92181231912"><strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row389218135338"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p3576115214619">public_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p35761552124618">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p19576252174619">Specifies the obtained EIP if only IPv4 EIPs are available. (IPv6 is not supported currently.)</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row2030210714336"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p5577105234617">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p2577165217467">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p10645141832513">Specifies the IP address version. The value can be <strong id="eip_api_0004__en-us_topic_0201534286_b1564812178518">4</strong> or <strong id="eip_api_0004__en-us_topic_0201534286_b6668217655">6</strong>.</p>
<ul id="eip_api_0004__en-us_topic_0201534286_ul13987110227"><li id="eip_api_0004__en-us_topic_0201534286_li998813101125"><strong id="eip_api_0004__en-us_topic_0201534286_b39751047115410">4</strong>: IPv4</li><li id="eip_api_0004__en-us_topic_0201534286_li45811172214"><strong id="eip_api_0004__en-us_topic_0201534286_b6278184212544">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row283940631880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p182177951880">private_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p60695041880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul1693412582014"><li id="eip_api_0004__en-us_topic_0201534286_li1993419562014">Specifies the private IP address bound to the EIP.</li><li id="eip_api_0004__en-us_topic_0201534286_li39348502011">This parameter is returned only when a port is associated with the EIP.</li></ul>
<div class="note" id="eip_api_0004__en-us_topic_0201534286_note233721920385"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534285_p194613206564">The value of <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534285_b11921103044817">private_ip_address</strong> is <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534285_b1799810360203">null</strong> if the EIP is bound to a dedicated load balancer.</p>
</div></div>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row264614551880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p630030811880">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p397229231880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul420471472010"><li id="eip_api_0004__en-us_topic_0201534286_li4203314152011">Specifies the port ID.</li><li id="eip_api_0004__en-us_topic_0201534286_li820412148206">This parameter is returned only when a port is associated with the EIP.</li></ul>
<div class="note" id="eip_api_0004__en-us_topic_0201534286_note06322034171917"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534072_p515453014185">The value of <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534072_b119455131612">port_id</strong> is null if the EIP is bound to a dedicated load balancer.</p>
</div></div>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row340905521880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p98713501880">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p58747301880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p269114516312">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row548200921880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p112424711880">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p92119381880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p36292894">Specifies the time (UTC) when the EIP is assigned.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row46164031880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p383843571880">bandwidth_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p473107141880">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p3934181618641">Specifies the ID of the EIP bandwidth.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row626637421880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p425983371880">bandwidth_size</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p463832691880">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p2365466">Specifies the bandwidth (Mbit/s).</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row576448061880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p387177161880">bandwidth_share_type</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p21369006155933">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul2255712095"><li id="eip_api_0004__en-us_topic_0201534286_li152514111893">Specifies the EIP bandwidth type.</li><li id="eip_api_0004__en-us_topic_0201534286_li194901613132012">The value can be <strong id="eip_api_0004__en-us_topic_0201534286_b65771539121116">PER</strong> or <strong id="eip_api_0004__en-us_topic_0201534286_b057811393110">WHOLE</strong>.<ul id="eip_api_0004__en-us_topic_0201534286_ul729412507220"><li id="eip_api_0004__en-us_topic_0201534286_li429475092212"><strong id="eip_api_0004__en-us_topic_0201534286_b130813427114">PER</strong>: Dedicated bandwidth</li><li id="eip_api_0004__en-us_topic_0201534286_li529411504225"><strong id="eip_api_0004__en-us_topic_0201534286_b20211104617117">WHOLE</strong>: Shared bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row1353343333617"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p19564181313543">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.90720927907209%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p13564413185412">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_api_0004__en-us_topic_0201534286_ul184004104214"><li id="eip_api_0004__en-us_topic_0201534286_li2400141032116">Specifies the enterprise project ID. The value is <strong id="eip_api_0004__en-us_topic_0201534286_b6349101114011">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="eip_api_0004__en-us_topic_0201534286_li2040016104214">When you assign an EIP, associate an enterprise project ID with the EIP.</li><li id="eip_api_0004__en-us_topic_0201534286_li693561319371">If this parameter is not specified, the default value is <strong id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534285_b01929345594">0</strong>, which indicates that the default enterprise project is used.</li></ul>
<div class="note" id="eip_api_0004__en-us_topic_0201534286_note13259152812017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0004__en-us_topic_0201534286_en-us_topic_0201534285_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0004__en-us_topic_0201534286_table66651219193417"></a><a name="en-us_topic_0201534286_table66651219193417"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0004__en-us_topic_0201534286_table66651219193417" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="eip_api_0004__en-us_topic_0201534286_b241655731310">profile</strong> field</caption><thead align="left"><tr id="eip_api_0004__en-us_topic_0201534286_row167319197349"><th align="left" class="cellrowborder" valign="top" width="37.35%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="eip_api_0004__en-us_topic_0201534286_p206761195347"><strong id="eip_api_0004__en-us_topic_0201534286_b155745220143">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.3%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="eip_api_0004__en-us_topic_0201534286_p156812193344"><strong id="eip_api_0004__en-us_topic_0201534286_b0811156101416">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.35%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="eip_api_0004__en-us_topic_0201534286_p17684101933410"><strong id="eip_api_0004__en-us_topic_0201534286_b19571413191416">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0004__en-us_topic_0201534286_row962259102216"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p962309182220">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p136231597223">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p26235912225">Specifies the order ID.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row18686141920341"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p11688201923418">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p169318196347">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p149921832153419">Specifies the product ID.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row167161319173418"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p5718101903412">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p47241019143417">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p09201951174716">Specifies the region ID.</p>
</td>
</tr>
<tr id="eip_api_0004__en-us_topic_0201534286_row1472971912347"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0004__en-us_topic_0201534286_p187311719103415">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_api_0004__en-us_topic_0201534286_p9735141923418">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_api_0004__en-us_topic_0201534286_p27381919173415">Specifies the user ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="eip_api_0004__en-us_topic_0201534286_li6162988394518">Example response (Binding an EIP to a NIC)<pre class="screen" id="eip_api_0004__en-us_topic_0201534286_screen10219162314912">{
"publicip": {
"id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb",
"status": "ACTIVE",
"profile": {},
"type": "5_bgp",
"port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe",
"public_ip_address": "10.xx.xx.162",
"private_ip_address": "192.168.1.131",
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
"create_time": "2019-03-27 01:33:18",
"bandwidth_size": 7,
"ip_version": 4,
"bandwidth_name": "bandwidth-2aef",
"enterprise_project_id": "0",
"bandwidth_share_type": "PER",
"bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0004__en-us_topic_0201534286_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_api_0004__en-us_topic_0201534286_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_api_0004__en-us_topic_0201534286_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_api_0004__en-us_topic_0201534286_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