yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
main
doc-exports/docs/eip/api-ref/eip_api_0002.html
fanqinying 406cbf6c6f EIP API 20251024 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2026-04-13 19:54:24 +00:00

330 lines
39 KiB
HTML
Raw Permalink Blame History

<a name="eip_api_0002"></a><a name="eip_api_0002"></a>
<h1 class="topictitle1">Querying an EIP</h1>
<div id="body8662426"><div class="section" id="eip_api_0002__en-us_topic_0201534285_section40040492"><h4 class="sectiontitle">Function</h4><p id="eip_api_0002__en-us_topic_0201534285_p12667213">This API is used to query a specific EIP.</p>
<div class="note" id="eip_api_0002__en-us_topic_0201534285_note13848133064014"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_p39817577485">Note the following when you use EIPs of the Dedicated Load Balancer (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b207851911124910">5_gray</strong>) type:<ul id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_ul18141507494"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_li86521438154">In <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b143161918816">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b193114191781">5_gray</strong>) type cannot be assigned anymore. You can assign EIPs of the BGP (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b12311419682">5_bgp</strong>) type.</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b1093341819529">5_gray</strong>) type can be bound to dedicated or shared load balancers.<ul id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_ul2044703613155"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_li1222113518159">The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_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_0002__en-us_topic_0201534285_en-us_topic_0201534068_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_0002__en-us_topic_0201534285_en-us_topic_0201534068_li1659819163617">You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.</li></ul>
</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534068_b153172301617">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_0002__en-us_topic_0201534285_section24820109"><h4 class="sectiontitle">URI</h4><p id="eip_api_0002__en-us_topic_0201534285_p933835161715">GET /v1/{project_id}/publicips/{publicip_id}</p>
<div class="p" id="eip_api_0002__en-us_topic_0201534285_p44901531163712"><a href="#eip_api_0002__en-us_topic_0201534285_table57982344">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_api_0002__en-us_topic_0201534285_table57982344"></a><a name="en-us_topic_0201534285_table57982344"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0002__en-us_topic_0201534285_table57982344" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_api_0002__en-us_topic_0201534285_row19130757"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_api_0002__en-us_topic_0201534285_p6087504">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="eip_api_0002__en-us_topic_0201534285_p23325828">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_0002__en-us_topic_0201534285_p10343879">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0002__en-us_topic_0201534285_row32547908"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p19134881">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_0002__en-us_topic_0201534285_p6421510">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_0002__en-us_topic_0201534285_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row50769665"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p18702178">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_0002__en-us_topic_0201534285_p38481481">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_0002__en-us_topic_0201534285_p29992219">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_api_0002__en-us_topic_0201534285_section22054394"><h4 class="sectiontitle">Request Parameters</h4><ul id="eip_api_0002__en-us_topic_0201534285_ul13450690"><li id="eip_api_0002__en-us_topic_0201534285_li54281744171719">Request parameter<p id="eip_api_0002__en-us_topic_0201534285_p7290172843716"><a name="eip_api_0002__en-us_topic_0201534285_li54281744171719"></a><a name="en-us_topic_0201534285_li54281744171719"></a>None</p>
</li><li id="eip_api_0002__en-us_topic_0201534285_li2887900894422">Example request<pre class="screen" id="eip_api_0002__en-us_topic_0201534285_screen195791196337">GET https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0002__en-us_topic_0201534285_section64271818"><h4 class="sectiontitle">Response Parameters</h4><ul id="eip_api_0002__en-us_topic_0201534285_ul13727043"><li id="eip_api_0002__en-us_topic_0201534285_li7793840">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0002__en-us_topic_0201534285_table64961662152123" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="eip_api_0002__en-us_topic_0201534285_row7248731152123"><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_0002__en-us_topic_0201534285_p50276345152123">Parameter</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_0002__en-us_topic_0201534285_p23039456152123">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_0002__en-us_topic_0201534285_p54256632152123">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0002__en-us_topic_0201534285_row32711048152123"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p32349241152123">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_0002__en-us_topic_0201534285_p45145628152123"><a href="#eip_api_0002__en-us_topic_0201534285_table3035698">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_0002__en-us_topic_0201534285_p27820057152123">Specifies the EIP object. For details, see <a href="#eip_api_0002__en-us_topic_0201534285_table3035698">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0002__en-us_topic_0201534285_table3035698"></a><a name="en-us_topic_0201534285_table3035698"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0002__en-us_topic_0201534285_table3035698" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_api_0002__en-us_topic_0201534285_b9762837195611">publicip</strong> field</caption><thead align="left"><tr id="eip_api_0002__en-us_topic_0201534285_row64466590"><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_0002__en-us_topic_0201534285_p54411269">Parameter</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_0002__en-us_topic_0201534285_p3124580518523">Type</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_0002__en-us_topic_0201534285_p40293226">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0002__en-us_topic_0201534285_row42525879"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p22044193">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_0002__en-us_topic_0201534285_p4788225318523">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_0002__en-us_topic_0201534285_p44048571">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row60892825"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p33371781">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_0002__en-us_topic_0201534285_p5325729418523">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_0002__en-us_topic_0201534285_ul1945793192"><li id="eip_api_0002__en-us_topic_0201534285_li19457911917">Specifies the EIP status.</li><li id="eip_api_0002__en-us_topic_0201534285_li1045149191913">Possible values are as follows:<ul id="eip_api_0002__en-us_topic_0201534285_ul4678228115815"><li id="eip_api_0002__en-us_topic_0201534285_li2061882375415"><strong id="eip_api_0002__en-us_topic_0201534285_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_api_0002__en-us_topic_0201534285_li9516132714542"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181622">BIND_ERROR</strong> (Binding failed)</li><li id="eip_api_0002__en-us_topic_0201534285_li142101130195412"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181646">BINDING</strong> (Binding)</li><li id="eip_api_0002__en-us_topic_0201534285_li18886123225416"><strong id="eip_api_0002__en-us_topic_0201534285_b84235270618176">PENDING_DELETE</strong> (Releasing)</li><li id="eip_api_0002__en-us_topic_0201534285_li18843635415"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181716">PENDING_CREATE</strong> (Assigning)</li><li id="eip_api_0002__en-us_topic_0201534285_li1197744545418"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181818">PENDING_UPDATE</strong> (Updating)</li><li id="eip_api_0002__en-us_topic_0201534285_li1487831953011"><strong id="eip_api_0002__en-us_topic_0201534285_b07851056439">NOTIFYING</strong> (Assigning)</li><li id="eip_api_0002__en-us_topic_0201534285_li1919318493119"><strong id="eip_api_0002__en-us_topic_0201534285_b16710182112314">NOTIFY_DELETE</strong> (Releasing)</li><li id="eip_api_0002__en-us_topic_0201534285_li19952124945414"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181834">DOWN</strong> (Unbound)</li><li id="eip_api_0002__en-us_topic_0201534285_li13389115319543"><strong id="eip_api_0002__en-us_topic_0201534285_b84235270610164">ACTIVE</strong> (Bound)</li><li id="eip_api_0002__en-us_topic_0201534285_li1572075905417"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706181859">ELB</strong> (Bound to a load balancer)</li><li id="eip_api_0002__en-us_topic_0201534285_li161441845132911"><strong id="eip_api_0002__en-us_topic_0201534285_b13716231932">VPN</strong> (Bound to a VPN)</li><li id="eip_api_0002__en-us_topic_0201534285_li82512401181"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706103022">ERROR</strong> (Exceptions)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row17803202152320"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p12971231132410"><a href="#eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p169773114242">Specifies the additional parameters, including the order ID and product ID. For details, see <a href="#eip_api_0002__en-us_topic_0201534285_table66651219193417">Table 4</a>.</p>
<p id="eip_api_0002__en-us_topic_0201534285_p1407131101719">This parameter is not supported currently.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row1722212174296"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p15848707">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_0002__en-us_topic_0201534285_p3408038918330">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_0002__en-us_topic_0201534285_ul7176216121014"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li54734919320">Range:<ul id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_ul1131620138312"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li117461515731">For region <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b1751313487372">eu-de</strong>: <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b13513144813717">5_bgp</strong> (Dynamic BGP), <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b15134483371">5_mailbgp</strong> (Mail BGP), <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b2513104818372">5_gray</strong> (Dedicated Load Balancer), and <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b4830184074818">5_dualStack</strong>.</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li139111439134111">For region <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b03113942612">eu-nl</strong>: <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b14311393266">5_bgp</strong> (Dynamic BGP), <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b931113913262">5_mailbgp</strong> (Mail BGP), and <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b935265074813">5_dualStack</strong></li></ul>
</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_ul9738153015499"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_li92181231912"><strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b960162813315">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b184991818937">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row19379155218596"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p59653533594">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_0002__en-us_topic_0201534285_p139651253165911">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_0002__en-us_topic_0201534285_p1696514537598">Specifies the obtained EIP if only IPv4 EIPs are available. Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available. IPv6 is not supported currently.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row180110932914"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p171101456172118">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_0002__en-us_topic_0201534285_p1811012569218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><div class="p" id="eip_api_0002__en-us_topic_0201534285_p1211011564217">Specifies the IP address version. The value can be <strong id="eip_api_0002__en-us_topic_0201534285_b842352706115744">4</strong> or <strong id="eip_api_0002__en-us_topic_0201534285_b842352706115748">6</strong>.<ul id="eip_api_0002__en-us_topic_0201534285_ul13987110227"><li id="eip_api_0002__en-us_topic_0201534285_li998813101125"><strong id="eip_api_0002__en-us_topic_0201534285_b15212202817495">4</strong>: IPv4</li><li id="eip_api_0002__en-us_topic_0201534285_li45811172214"><strong id="eip_api_0002__en-us_topic_0201534285_b3619113024916">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
</div>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row66070243"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p50089467">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_0002__en-us_topic_0201534285_p1357258018523">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_0002__en-us_topic_0201534285_ul1693412582014"><li id="eip_api_0002__en-us_topic_0201534285_li1993419562014">Specifies the private IP address bound to the EIP.</li><li id="eip_api_0002__en-us_topic_0201534285_li39348502011">This parameter is returned only if the private IP address is bound to the EIP.</li></ul>
<div class="note" id="eip_api_0002__en-us_topic_0201534285_note694662018562"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0002__en-us_topic_0201534285_p194613206564">This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS.</p>
</div></div>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row12246230153229"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p11971849153234">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_0002__en-us_topic_0201534285_p2563717518523">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_0002__en-us_topic_0201534285_ul420471472010"><li id="eip_api_0002__en-us_topic_0201534285_li4203314152011">Specifies the port ID.</li><li id="eip_api_0002__en-us_topic_0201534285_li820412148206">This parameter is returned only when a port is associated with the EIP.</li></ul>
<div class="note" id="eip_api_0002__en-us_topic_0201534285_note06322034171917"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534072_p515453014185">The value of <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534072_b191121153105620">port_id</strong> is null if the EIP is bound to a dedicated load balancer.</p>
</div></div>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row7204713"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p46710863">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_0002__en-us_topic_0201534285_p6334526618523">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_0002__en-us_topic_0201534285_p25354291121">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row55494360"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p65858198">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_0002__en-us_topic_0201534285_p3069292618523">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_0002__en-us_topic_0201534285_p36292894">Specifies the time (UTC) when the EIP is assigned.</p>
<p id="eip_api_0002__en-us_topic_0201534285_p7682202016546">Format: <em id="eip_api_0002__en-us_topic_0201534285_i881472114480">yyyy-MM-dd HH:mm:ss</em></p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row58200593"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p16627584">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_0002__en-us_topic_0201534285_p309907418523">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_0002__en-us_topic_0201534285_p3934181618641">Specifies the ID of the EIP bandwidth.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row51415138"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p3876622">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_0002__en-us_topic_0201534285_p4969847118523">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_0002__en-us_topic_0201534285_p2365466">Specifies the bandwidth (Mbit/s).</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row21289199"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p46703582">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_0002__en-us_topic_0201534285_p6615323718523">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_0002__en-us_topic_0201534285_ul2255712095"><li id="eip_api_0002__en-us_topic_0201534285_li152514111893">Specifies the EIP bandwidth type.</li><li id="eip_api_0002__en-us_topic_0201534285_li194901613132012">The value can be <strong id="eip_api_0002__en-us_topic_0201534285_b732433921164019">PER</strong> or <strong id="eip_api_0002__en-us_topic_0201534285_b1729357023164019">WHOLE</strong>.<ul id="eip_api_0002__en-us_topic_0201534285_ul729412507220"><li id="eip_api_0002__en-us_topic_0201534285_li429475092212"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706204716">PER</strong>: Dedicated bandwidth</li><li id="eip_api_0002__en-us_topic_0201534285_li529411504225"><strong id="eip_api_0002__en-us_topic_0201534285_b842352706204729">WHOLE</strong>: Shared bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row5951536918414"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p6587627918414">bandwidth_name</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_0002__en-us_topic_0201534285_p3318647218414">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_0002__en-us_topic_0201534285_p374970718414">Specifies the bandwidth name.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row7438151912404"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p979842771215">alias</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_0002__en-us_topic_0201534285_p137987278128">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_0002__en-us_topic_0201534285_p175531744191218">Specifies the EIP name.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row1066119511342"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_ul184004104214"><li id="eip_api_0002__en-us_topic_0201534285_li2400141032116">Specifies the enterprise project ID. The value is <strong id="eip_api_0002__en-us_topic_0201534285_b16884458183812">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="eip_api_0002__en-us_topic_0201534285_li2040016104214">When assigning an EIP, you need to associate an enterprise project ID with the EIP.</li><li id="eip_api_0002__en-us_topic_0201534285_li5375513174417">If this parameter is not specified, the default value is <strong id="eip_api_0002__en-us_topic_0201534285_b01929345594">0</strong>, which indicates that the default enterprise project is used.</li></ul>
<div class="note" id="eip_api_0002__en-us_topic_0201534285_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row0494191811246"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p1388313292268">public_border_group</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_0002__en-us_topic_0201534285_p118831329122611">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_0002__en-us_topic_0201534285_p29889336324">Specifies whether it is in a central site or an edge site.</p>
<p id="eip_api_0002__en-us_topic_0201534285_p20127195053611">The value can be:</p>
<ul id="eip_api_0002__en-us_topic_0201534285_ul1660185933618"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534115_li761175917369">center</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534115_li1761759193615"><em id="eip_api_0002__en-us_topic_0201534285_i332885354519">Edge site name</em></li></ul>
<p id="eip_api_0002__en-us_topic_0201534285_p65761507386">An EIP can only be bound to a resource of the same region.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row1623670161"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p17216171341115">allow_share_bandwidth_types</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_0002__en-us_topic_0201534285_p13216141361114">Array of strings</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_0002__en-us_topic_0201534285_p4392175712402">Specifies types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth.</p>
<p id="eip_api_0002__en-us_topic_0201534285_p53921357194011">The EIP can be added only to the shared bandwidth of these types.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row9428524164211"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p731513226421">tags</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_0002__en-us_topic_0201534285_p19204181024017">Array of strings</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_0002__en-us_topic_0201534285_p1132719151774">Specifies the list of tags. The list elements are in the format of <em id="eip_api_0002__en-us_topic_0201534285_i35637781317">key=value</em>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0002__en-us_topic_0201534285_table66651219193417"></a><a name="en-us_topic_0201534285_table66651219193417"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0002__en-us_topic_0201534285_table66651219193417" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="eip_api_0002__en-us_topic_0201534285_b13169194715536">profile</strong> field</caption><thead align="left"><tr id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p206761195347"><strong id="eip_api_0002__en-us_topic_0201534285_b3371155162638">Parameter</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_0002__en-us_topic_0201534285_p156812193344">Type</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_0002__en-us_topic_0201534285_p17684101933410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0002__en-us_topic_0201534285_row962259102216"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p26235912225">Specifies the order ID.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row18686141920341"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p149921832153419">Specifies the product ID.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row167161319173418"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p09201951174716">Specifies the region ID.</p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row1472971912347"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_p09931918183013">Specifies the user ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0000001405140586_response_ResourceTagResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResourceTagResp</caption><thead align="left"><tr id="eip_api_0002__en-us_topic_0201534285_row12205191016402"><th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="eip_api_0002__en-us_topic_0201534285_p1820510105409">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.02%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="eip_api_0002__en-us_topic_0201534285_p7205141020408">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="eip_api_0002__en-us_topic_0201534285_p1620581014016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0002__en-us_topic_0201534285_row3205810164013"><td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p15206810164019">key</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="eip_api_0002__en-us_topic_0201534285_p7206201010403">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><ul id="eip_api_0002__en-us_topic_0201534285_ul19206131014014"><li id="eip_api_0002__en-us_topic_0201534285_li520631024019">Tag key</li><li id="eip_api_0002__en-us_topic_0201534285_li22064107407">Constraints:<ul id="eip_api_0002__en-us_topic_0201534285_ul19206151012402"><li id="eip_api_0002__en-us_topic_0201534285_li2206171018402">Cannot be left blank.</li><li id="eip_api_0002__en-us_topic_0201534285_li14206201024013">Can contain a maximum of 36 characters.</li><li id="eip_api_0002__en-us_topic_0201534285_li1120661044016">Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).</li><li id="eip_api_0002__en-us_topic_0201534285_li10207210154013">The tag key of an EIP must be unique.</li></ul>
</li></ul>
<p id="eip_api_0002__en-us_topic_0201534285_p142071010134013">Minimum length: <strong id="eip_api_0002__en-us_topic_0201534285_b19580125718538">0</strong></p>
<p id="eip_api_0002__en-us_topic_0201534285_p7207121020407">Maximum length: <strong id="eip_api_0002__en-us_topic_0201534285_b107796005418">36</strong></p>
</td>
</tr>
<tr id="eip_api_0002__en-us_topic_0201534285_row1620515108400"><td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="eip_api_0002__en-us_topic_0201534285_p16207310134014">value</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="eip_api_0002__en-us_topic_0201534285_p17207510154011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><ul id="eip_api_0002__en-us_topic_0201534285_ul820751054015"><li id="eip_api_0002__en-us_topic_0201534285_li112078106404">Tag value</li><li id="eip_api_0002__en-us_topic_0201534285_li10207201011401">Constraints:<ul id="eip_api_0002__en-us_topic_0201534285_ul7207610114016"><li id="eip_api_0002__en-us_topic_0201534285_li142071210134016">Can contain a maximum of 43 characters.</li><li id="eip_api_0002__en-us_topic_0201534285_li112071101408">Can contain letters and special characters, including hyphens (-), underscores (_), and at signs (@).</li><li id="eip_api_0002__en-us_topic_0201534285_li1120811014405">The tag key of an EIP must be unique.</li></ul>
</li></ul>
<p id="eip_api_0002__en-us_topic_0201534285_p1320813105403">Minimum length: <strong id="eip_api_0002__en-us_topic_0201534285_b126591940155317">0</strong></p>
<p id="eip_api_0002__en-us_topic_0201534285_p820871044016">Maximum length: <strong id="eip_api_0002__en-us_topic_0201534285_b1461745165314">43</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="eip_api_0002__en-us_topic_0201534285_ul6007868294430"><li id="eip_api_0002__en-us_topic_0201534285_li383722794430">Example response<pre class="screen" id="eip_api_0002__en-us_topic_0201534285_screen4102504144219">{
"publicip": {
"id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
"status": "DOWN",
"alias": "tom",
"profile": {},
"type": "5_bgp",
"public_ip_address": "161.xx.xx.12",
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"private_ip_address": "192.168.10.5",
"create_time": "2015-07-16 04:32:50",
"bandwidth_id": "49c8825b-bed9-46ff-9416-704b96d876a2",
"bandwidth_share_type": "PER",
"bandwidth_size": 10, //The EIP bandwidth size is 10 Mbit/s.
"bandwidth_name": "bandwidth-test",
"enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
"ip_version": 4
}
}</pre>
</li></ul>
<div class="section" id="eip_api_0002__en-us_topic_0201534285_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_api_0002__en-us_topic_0201534285_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_api_0002__en-us_topic_0201534285_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_api_0002__en-us_topic_0201534285_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