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

308 lines
37 KiB
HTML
Raw Permalink Blame History

<a name="eip_api_0003"></a><a name="eip_api_0003"></a>
<h1 class="topictitle1">Querying EIPs</h1>
<div id="body8662426"><div class="section" id="eip_api_0003__en-us_topic_0201534309_section52618256"><h4 class="sectiontitle">Function</h4><p id="eip_api_0003__en-us_topic_0201534309_p1721653">This API is used to query EIPs.</p>
<div class="note" id="eip_api_0003__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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_b1958731314398">5_gray</strong>) type:<ul id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_ul18141507494"><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_li86521438154">In <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_b126181649151714">eu-de</strong>, EIPs of the Dedicated Load Balancer (<strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_b1874731121812">5_bgp</strong>) type.</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_li1194114411236">Existing EIPs of the Dedicated Load Balancer (<strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_ul2044703613155"><li id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_en-us_topic_0201534274_en-us_topic_0118498850_li1468695512506">Do not add EIPs of the dedicated load balancer type (<strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_section3802258"><h4 class="sectiontitle">URI</h4><p id="eip_api_0003__en-us_topic_0201534309_p17276143618227">GET /v1/{project_id}/publicips</p>
<div class="p" id="eip_api_0003__en-us_topic_0201534309_p828210438229"><a href="#eip_api_0003__en-us_topic_0201534309_table51200735">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_api_0003__en-us_topic_0201534309_table51200735"></a><a name="en-us_topic_0201534309_table51200735"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0003__en-us_topic_0201534309_table51200735" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_api_0003__en-us_topic_0201534309_row8909633"><th align="left" class="cellrowborder" valign="top" width="24.997500249975%" id="mcps1.3.2.3.2.2.5.1.1"><p id="eip_api_0003__en-us_topic_0201534309_p50591634">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.62753724627537%" id="mcps1.3.2.3.2.2.5.1.2"><p id="eip_api_0003__en-us_topic_0201534309_p4281684">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.548045195480455%" id="mcps1.3.2.3.2.2.5.1.3"><p id="eip_api_0003__en-us_topic_0201534309_p2939873918724">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.2.3.2.2.5.1.4"><p id="eip_api_0003__en-us_topic_0201534309_p11272110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0003__en-us_topic_0201534309_row40625737"><td class="cellrowborder" valign="top" width="24.997500249975%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p2350413">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.62753724627537%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="eip_api_0003__en-us_topic_0201534309_p56165728">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.548045195480455%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="eip_api_0003__en-us_topic_0201534309_p3248766718724">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="eip_api_0003__en-us_topic_0201534309_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row8409368"><td class="cellrowborder" valign="top" width="24.997500249975%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p10070188">marker</p>
</td>
<td class="cellrowborder" valign="top" width="24.62753724627537%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="eip_api_0003__en-us_topic_0201534309_p10378893">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.548045195480455%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="eip_api_0003__en-us_topic_0201534309_p1425535118724">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="eip_api_0003__en-us_topic_0201534309_p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
<p id="eip_api_0003__en-us_topic_0201534309_p538818488578">This parameter can work together with the parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b650614119446">limit</strong>.</p>
<ul id="eip_api_0003__en-us_topic_0201534309_ul12704811125810"><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_li325418407124">If parameters <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b736582413514">marker</strong> and <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_li1923817171338">If the parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b14146122925417">limit</strong> is set to <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_li2076741203417">If the value of the parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b1557415118357">limit</strong> is set to <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_li108512113551">If the value of the parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row25110514"><td class="cellrowborder" valign="top" width="24.997500249975%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p20685786">limit</p>
</td>
<td class="cellrowborder" valign="top" width="24.62753724627537%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="eip_api_0003__en-us_topic_0201534309_p64935954">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.548045195480455%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="eip_api_0003__en-us_topic_0201534309_p1383277618724">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="eip_api_0003__en-us_topic_0201534309_p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.</p>
<p id="eip_api_0003__en-us_topic_0201534309_p125192338584"><strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b7164124258">limit</strong> can be used together with <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b15985310854">marker</strong>. For details, see the parameter description of <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534109_b193281854847">marker</strong>.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row13633172111266"><td class="cellrowborder" valign="top" width="24.997500249975%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p55289571029">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.62753724627537%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="eip_api_0003__en-us_topic_0201534309_p15529457128">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.548045195480455%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="eip_api_0003__en-us_topic_0201534309_p165291857925">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.3.2.2.5.1.4 "><ul id="eip_api_0003__en-us_topic_0201534309_ul152391731105011"><li id="eip_api_0003__en-us_topic_0201534309_li1123993155013">Specifies the enterprise project ID. This field can be used to filter the EIPs of an enterprise project.</li><li id="eip_api_0003__en-us_topic_0201534309_li152395319503">The value is <strong id="eip_api_0003__en-us_topic_0201534309_b1284081419393">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="eip_api_0003__en-us_topic_0201534309_b18001519203918">0</strong> indicates the default enterprise project. To obtain the EIPs bound to all enterprise projects of the user, set <strong id="eip_api_0003__en-us_topic_0201534309_b185061540163015">all_granted_eps</strong>.</li></ul>
<div class="note" id="eip_api_0003__en-us_topic_0201534309_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0003__en-us_topic_0201534309_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>
</div>
<div class="section" id="eip_api_0003__en-us_topic_0201534309_section34220326"><h4 class="sectiontitle">Request Message</h4><ul id="eip_api_0003__en-us_topic_0201534309_ul35977388"><li id="eip_api_0003__en-us_topic_0201534309_li55059565">Request parameter<p id="eip_api_0003__en-us_topic_0201534309_p4695104463717"><a name="eip_api_0003__en-us_topic_0201534309_li55059565"></a><a name="en-us_topic_0201534309_li55059565"></a>None</p>
</li><li id="eip_api_0003__en-us_topic_0201534309_li2882381194438">Example request<pre class="screen" id="eip_api_0003__en-us_topic_0201534309_screen11997242111813">GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&amp;marker={marker}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0003__en-us_topic_0201534309_section39547486"><h4 class="sectiontitle">Response Message</h4><ul id="eip_api_0003__en-us_topic_0201534309_ul7322556"><li id="eip_api_0003__en-us_topic_0201534309_li36543171">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0003__en-us_topic_0201534309_table22603002152149" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="eip_api_0003__en-us_topic_0201534309_row30843029152149"><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_0003__en-us_topic_0201534309_p15257431152149">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_0003__en-us_topic_0201534309_p44693705152149">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_0003__en-us_topic_0201534309_p63420361152149">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0003__en-us_topic_0201534309_row36775597152149"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p26033374152149">publicips</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_0003__en-us_topic_0201534309_p746714339186">Array of <a href="#eip_api_0003__en-us_topic_0201534309_table83964341880">publicips</a> objects</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_0003__en-us_topic_0201534309_p14951203152149">Specifies the EIP object. For details, see <a href="#eip_api_0003__en-us_topic_0201534309_table83964341880">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0003__en-us_topic_0201534309_table83964341880"></a><a name="en-us_topic_0201534309_table83964341880"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0003__en-us_topic_0201534309_table83964341880" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_api_0003__en-us_topic_0201534309_b19241912403">publicips</strong> field</caption><thead align="left"><tr id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p318442431880">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_0003__en-us_topic_0201534309_p201897271880">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_0003__en-us_topic_0201534309_p247551571880">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0003__en-us_topic_0201534309_row590107001880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p205460611880">Specifies the unique identifier of an EIP.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row506968211880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul263945115243"><li id="eip_api_0003__en-us_topic_0201534309_li15639135162419">Specifies the EIP status.</li><li id="eip_api_0003__en-us_topic_0201534309_li186392518245">Possible values are as follows:<ul id="eip_api_0003__en-us_topic_0201534309_ul7905205815810"><li id="eip_api_0003__en-us_topic_0201534309_li2061882375415"><strong id="eip_api_0003__en-us_topic_0201534309_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_api_0003__en-us_topic_0201534309_li9516132714542"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181622">BIND_ERROR</strong> (Binding failed)</li><li id="eip_api_0003__en-us_topic_0201534309_li142101130195412"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181646">BINDING</strong> (Binding)</li><li id="eip_api_0003__en-us_topic_0201534309_li18886123225416"><strong id="eip_api_0003__en-us_topic_0201534309_b84235270618176">PENDING_DELETE</strong> (Releasing)</li><li id="eip_api_0003__en-us_topic_0201534309_li18843635415"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181716">PENDING_CREATE</strong> (Assigning)</li><li id="eip_api_0003__en-us_topic_0201534309_li1197744545418"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181818">PENDING_UPDATE</strong> (Updating)</li><li id="eip_api_0003__en-us_topic_0201534309_li19952124945414"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181834">DOWN</strong> (Unbound)</li><li id="eip_api_0003__en-us_topic_0201534309_li13389115319543"><strong id="eip_api_0003__en-us_topic_0201534309_b84235270610164">ACTIVE</strong> (Bound)</li><li id="eip_api_0003__en-us_topic_0201534309_li1572075905417"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706181859">ELB</strong> (Bound to a load balancer)</li><li id="eip_api_0003__en-us_topic_0201534309_li661175417182"><strong id="eip_api_0003__en-us_topic_0201534309_b842352706103022">ERROR</strong> (Exceptions)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row16130133562319"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p12971231132410">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_0003__en-us_topic_0201534309_p5644118182514">Specifies the additional parameters, including the order ID and product ID. For details, see <a href="#eip_api_0003__en-us_topic_0201534309_table66651219193417">Table 4</a>.</p>
<p id="eip_api_0003__en-us_topic_0201534309_p1407131101719">This parameter is not supported currently.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row230260811880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul7176216121014"><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_ul9738153015499"><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_li92181231912"><strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row389218135338"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p59108624">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_0003__en-us_topic_0201534309_p904808818330">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_0003__en-us_topic_0201534309_p40237373">Specifies the obtained EIP if only IPv4 EIPs are available.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row2030210714336"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p1811012569218">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_0003__en-us_topic_0201534309_p10645141832513">Specifies the IP address version. The value can be <strong id="eip_api_0003__en-us_topic_0201534309_b842352706115744">4</strong> or <strong id="eip_api_0003__en-us_topic_0201534309_b842352706115748">6</strong>.</p>
<ul id="eip_api_0003__en-us_topic_0201534309_ul13987110227"><li id="eip_api_0003__en-us_topic_0201534309_li998813101125"><strong id="eip_api_0003__en-us_topic_0201534309_b3611513135310">4</strong>: IPv4</li><li id="eip_api_0003__en-us_topic_0201534309_li45811172214"><strong id="eip_api_0003__en-us_topic_0201534309_b170634213512">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row283940631880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul1693412582014"><li id="eip_api_0003__en-us_topic_0201534309_li1993419562014">Specifies the private IP address bound to the EIP.</li><li id="eip_api_0003__en-us_topic_0201534309_li39348502011">This parameter is returned only if the private IP address is bound to the EIP.</li></ul>
<div class="note" id="eip_api_0003__en-us_topic_0201534309_note233721920385"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534285_p194613206564">The value of <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534285_b11921103044817">private_ip_address</strong> is <strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_row264614551880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul420471472010"><li id="eip_api_0003__en-us_topic_0201534309_li4203314152011">Specifies the port ID.</li><li id="eip_api_0003__en-us_topic_0201534309_li820412148206">This parameter is returned only when a port is associated with the EIP.</li></ul>
<div class="note" id="eip_api_0003__en-us_topic_0201534309_note06322034171917"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534072_p515453014185">The value of <strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_row340905521880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p19867509217">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row548200921880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p36292894">Specifies the time (UTC) when the EIP is assigned.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row46164031880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p3934181618641">Specifies the ID of the EIP bandwidth.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row626637421880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p2365466">Specifies the bandwidth (Mbit/s).</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row576448061880"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul2255712095"><li id="eip_api_0003__en-us_topic_0201534309_li152514111893">Specifies the EIP bandwidth type.</li><li id="eip_api_0003__en-us_topic_0201534309_li194901613132012">The value can be <strong id="eip_api_0003__en-us_topic_0201534309_b15499145815393">PER</strong> or <strong id="eip_api_0003__en-us_topic_0201534309_b6500558143916">WHOLE</strong>.<ul id="eip_api_0003__en-us_topic_0201534309_ul729412507220"><li id="eip_api_0003__en-us_topic_0201534309_li429475092212"><strong id="eip_api_0003__en-us_topic_0201534309_b16410175912395">PER</strong>: Dedicated bandwidth</li><li id="eip_api_0003__en-us_topic_0201534309_li529411504225"><strong id="eip_api_0003__en-us_topic_0201534309_b114998124012">WHOLE</strong>: Shared bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row1444049321927"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_p605297721941">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_0003__en-us_topic_0201534309_p5224891921941">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_0003__en-us_topic_0201534309_p374970718414">Specifies the bandwidth name.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row1353343333617"><td class="cellrowborder" valign="top" width="36.046395360463954%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_ul184004104214"><li id="eip_api_0003__en-us_topic_0201534309_li2400141032116">Specifies the enterprise project ID. The value is <strong id="eip_api_0003__en-us_topic_0201534309_b381316286396">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="eip_api_0003__en-us_topic_0201534309_li2040016104214">When assigning an EIP, you need to associate an enterprise project ID with the EIP.</li><li id="eip_api_0003__en-us_topic_0201534309_li693561319371">If this parameter is not specified, the default value is <strong id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534285_b01929345594">0</strong>, which indicates that the default enterprise project is used.</li></ul>
<div class="note" id="eip_api_0003__en-us_topic_0201534309_note13259152812017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_api_0003__en-us_topic_0201534309_en-us_topic_0201534285_en-us_topic_0201534275_p182751511487_1">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_api_0003__en-us_topic_0201534309_table66651219193417"></a><a name="en-us_topic_0201534309_table66651219193417"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_api_0003__en-us_topic_0201534309_table66651219193417" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="eip_api_0003__en-us_topic_0201534309_b05378248534">profile</strong> field</caption><thead align="left"><tr id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p206761195347"><strong id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p17684101933410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_api_0003__en-us_topic_0201534309_row962259102216"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p26235912225">Specifies the order ID.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row18686141920341"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p149921832153419">Specifies the product ID.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row167161319173418"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p09201951174716">Specifies the region ID.</p>
</td>
</tr>
<tr id="eip_api_0003__en-us_topic_0201534309_row1472971912347"><td class="cellrowborder" valign="top" width="37.35%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_api_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_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_0003__en-us_topic_0201534309_p27381919173415">Specifies the user ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="eip_api_0003__en-us_topic_0201534309_li66192019450">Example response<pre class="screen" id="eip_api_0003__en-us_topic_0201534309_screen24376929144312">{
"publicips": [
{
"id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
"status": "DOWN",
"profile": {},
"type": "5_bgp",
"public_ip_address": "161.xx.xx.9",
"private_ip_address": "192.168.10.5",
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"create_time": "2015-07-16 04:22:32",
"bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
"bandwidth_share_type": "PER",
"bandwidth_size": 5,
"bandwidth_name": "bandwidth-test",
"enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
"ip_version": 4
},
{
"id": "80d5b82e-43b9-4f82-809a-37bec5793bd4",
"status": "DOWN",
"profile": {},
"type": "5_bgp",
"public_ip_address": "161.xx.xx.10",
"private_ip_address": "192.168.10.6",
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"create_time": "2015-07-16 04:23:03",
"bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a",
"bandwidth_share_type": "PER",
"bandwidth_size": 5,
"bandwidth_name": "bandwidth-test1",
"enterprise_project_id":"0",
"ip_version": 4
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="eip_api_0003__en-us_topic_0201534309_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_api_0003__en-us_topic_0201534309_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_api_0003__en-us_topic_0201534309_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_api_0003__en-us_topic_0201534309_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