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>
166 lines
18 KiB
HTML
166 lines
18 KiB
HTML
<a name="eip_apisharedbandwidth_0005"></a><a name="eip_apisharedbandwidth_0005"></a>
|
|
|
|
<h1 class="topictitle1">Removing an EIP from a Shared Bandwidth</h1>
|
|
<div id="body8662426"><div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section16581154"><h4 class="sectiontitle">Function</h4><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p28896937">This API is used to remove an EIP from a shared bandwidth.</p>
|
|
</div>
|
|
<div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section15012662"><h4 class="sectiontitle">URI</h4><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p6642854475">POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove</p>
|
|
<div class="p" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p15891495418"><a href="#eip_apisharedbandwidth_0005__en-us_topic_0201534216_table25281875">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table25281875"></a><a name="en-us_topic_0201534216_table25281875"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table25281875" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row26712487"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p16227847"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b842352706195711">Name</strong></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_apisharedbandwidth_0005__en-us_topic_0201534216_p39387211"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b84235270615219">Mandatory</strong></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_apisharedbandwidth_0005__en-us_topic_0201534216_p36247516"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b8423527061645">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row50367649"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p53247746">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_apisharedbandwidth_0005__en-us_topic_0201534216_p18100201">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row41709209"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p23002745">bandwidth_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p51283066">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p60287683">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section896237"><h4 class="sectiontitle">Request Message</h4><ul id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_ul51464189"><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li3539410">Request parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table3057854815556" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row6286666315556"><th align="left" class="cellrowborder" valign="top" width="15.409999999999998%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p5903494715556"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1287126613">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p1710139915556"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1064177579">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p4303610815556"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b842352706145623">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.18%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p6337274615556"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1096129400">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row3291877615556"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p4917516615556">bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p2376550915556">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p4595806815556"><a href="#eip_apisharedbandwidth_0005__en-us_topic_0201534216_table31854691">bandwidth</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.18%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p1610901815556">Specifies the bandwidth objects. For details, see <a href="#eip_apisharedbandwidth_0005__en-us_topic_0201534216_table31854691">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table31854691"></a><a name="en-us_topic_0201534216_table31854691"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table31854691" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b15173112712819">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row6882862"><th align="left" class="cellrowborder" valign="top" width="13.350000000000001%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p20640979"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b422758361">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.91%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p61306625"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1517416491">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.91%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p5200653172316"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1429852111">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.830000000000005%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p66889567"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b707345171">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row49345813"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p37587916">publicip_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p24722347">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p18599757172316">Array of <a href="#eip_apisharedbandwidth_0005__en-us_topic_0201534216_table30936422">publicip_info</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.830000000000005%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_ul290995117818"><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li190919517818">Specifies information about the EIP to be removed from the bandwidth. For details, see <a href="#eip_apisharedbandwidth_0005__en-us_topic_0201534216_table30936422">Table 4</a>.</li><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li1590916511487">The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b15544155032912">WHOLE</strong>, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row193703372412"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p183711037154117">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p17371237114118">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p15371143714413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.830000000000005%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p877125719190">After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth.</p>
|
|
<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p29217211425">Specifies whether the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth is billed by traffic or by bandwidth.</p>
|
|
<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p179232117423">The value can be <strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b84235270618043">bandwidth</strong> or <strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b84235270618050">traffic</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row1125210414413"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p1425214412410">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p1525210418416">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.91%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p7252164114118">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.830000000000005%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p42481825142019">After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth.</p>
|
|
<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p16249725152011">Specifies the size (Mbit/s) of the dedicated bandwidth used by the EIP that has been removed from a shared bandwidth.</p>
|
|
<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p721494415220">The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table30936422"></a><a name="en-us_topic_0201534216_table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_table30936422" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b51948857105640">publicip_info</strong> object</caption><thead align="left"><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row17161430"><th align="left" class="cellrowborder" valign="top" width="13.3%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p47898561"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1801640043">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.02%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p157089251981"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1041916792">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.96%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p2828296517154"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b365838283">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.72%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p58761073"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b1161305333">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_row62026502"><td class="cellrowborder" valign="top" width="13.3%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p58090788">publicip_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p10708102514810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.96%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p921881117154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.72%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p476380">Specifies the ID of the EIP that uses the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_ul97325109472"><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li204837269472">Example request<pre class="screen" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_screen47283213144618">POST <em id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_i127567010225"><strong id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_b97561502226"></strong></em>https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/remove
|
|
|
|
{
|
|
"bandwidth": {
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "d91b0028-6f6b-4478-808a-297b75b6812a"
|
|
|
|
},
|
|
{
|
|
"publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
|
|
}
|
|
],
|
|
"charge_mode": "traffic",
|
|
"size": 22
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section8066134"><h4 class="sectiontitle">Response Message</h4><ul id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_ul376984994712"><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li195917277910">Response parameter<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p116261239999"><a name="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li195917277910"></a><a name="en-us_topic_0201534216_li195917277910"></a>None</p>
|
|
</li><li id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li3392864794712">Example response<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p15742133184415"><a name="eip_apisharedbandwidth_0005__en-us_topic_0201534216_li3392864794712"></a><a name="en-us_topic_0201534216_li3392864794712"></a>None</p>
|
|
<p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p18928431339">Or</p>
|
|
<pre class="screen" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_screen4107195914332">{
|
|
"code":"xxx",
|
|
"message":"xxxxx"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_apisharedbandwidth_0005__en-us_topic_0201534216_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_apisharedbandwidth_0000.html">Bandwidth (V2.0)</a></div>
|
|
</div>
|
|
</div>
|
|
|