forked from docs/doc-exports
Qin Ying, Fan
65b77b76d4
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>
262 lines
31 KiB
HTML
262 lines
31 KiB
HTML
<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_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_0002__en-us_topic_0201534285_en-us_topic_0118498850_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_0118498850_b1958731314398">5_gray</strong>) type:<ul id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_ul18141507494"><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_li86521438154">In <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_b108739322183">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_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0118498850_b113526330389">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_0118498850_ul2044703613155"><li id="eip_api_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_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_0002__en-us_topic_0201534285_en-us_topic_0118498850_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_api_0002__en-us_topic_0201534285_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_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">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_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 Message</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 Message</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">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_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">Name</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_li95615391617">The value can be <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</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_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0002__en-us_topic_0201534285_en-us_topic_0201534274_b819152812216">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">The value of <strong id="eip_api_0002__en-us_topic_0201534285_b11921103044817">private_ip_address</strong> is <strong id="eip_api_0002__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_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_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_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>
|
|
</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_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>
|
|
</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">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_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>
|
|
</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",
|
|
"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>
|
|
|