vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/eip/api-ref/eip_apisharedbandwidth_0004.html
Qin Ying, Fan 65b77b76d4 EIP API 20230106 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2023-08-01 06:58:15 +00:00

319 lines
38 KiB
HTML
Raw Blame History

<a name="eip_apisharedbandwidth_0004"></a><a name="eip_apisharedbandwidth_0004"></a>
<h1 class="topictitle1">Adding an EIP to a Shared Bandwidth</h1>
<div id="body8662426"><div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section16581154"><h4 class="sectiontitle">Function</h4><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p28896937">This API is used to add an EIP to a shared bandwidth.</p>
</div>
<div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section15012662"><h4 class="sectiontitle">URI</h4><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p3151221424">POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert</p>
<div class="p" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p476075685316"><a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table25281875">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table25281875"></a><a name="en-us_topic_0201534131_table25281875"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table25281875" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p16227847"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p39387211"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p36247516"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b8423527061645">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row50367649"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row41709209"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p60287683">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section896237"><h4 class="sectiontitle">Request Message</h4><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul51464189"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li3539410">Request parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table3057854815556" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p5903494715556"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1688611181">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_0004__en-us_topic_0201534131_p1710139915556"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1095917702">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_0004__en-us_topic_0201534131_p4303610815556"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p6337274615556"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b2131197087">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row3291877615556"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p4595806815556"><a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p1610901815556">Specifies the bandwidth objects. For details, see <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table31854691">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table31854691"></a><a name="en-us_topic_0201534131_table31854691"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table31854691" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b5147827202516">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p20640979"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1022950524">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_0004__en-us_topic_0201534131_p61306625"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b2086372903">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_0004__en-us_topic_0201534131_p5200653172316"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1491263929">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_0004__en-us_topic_0201534131_p66889567"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1383018343">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row49345813"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p18599757172316">Array of <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_ul1057071610312"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li1457091618313">Specifies information about the EIP to be added to the shared bandwidth. For details, see <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table30936422">Table 4</a>.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li9570116431">The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b283219143914">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>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table30936422"></a><a name="en-us_topic_0201534131_table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table30936422" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b51948857105640">publicip_info</strong> object</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row17161430"><th align="left" class="cellrowborder" valign="top" width="14.29%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p47898561"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1794384123">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.03%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p169718416504"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1838199425">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_0004__en-us_topic_0201534131_p2828296517154"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1739723590">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_0004__en-us_topic_0201534131_p58761073"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1699509421">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row62026502"><td class="cellrowborder" valign="top" width="14.29%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p58090788">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.03%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p79716416504">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_0004__en-us_topic_0201534131_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_0004__en-us_topic_0201534131_p476380">Specifies the ID of the EIP that uses the bandwidth.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row144151444141"><td class="cellrowborder" valign="top" width="14.29%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p490210492147">publicip_type</p>
</td>
<td class="cellrowborder" valign="top" width="17.03%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p4902154913141">No</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_0004__en-us_topic_0201534131_p9902149171411">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.72%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul14903154919144"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_ul9738153015499"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li92181231912"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul97325109472"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li204837269472">Example request<pre class="screen" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_screen47283213144618">POST <em id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_i171005200214"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b10100820122118"></strong></em>https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
{
"bandwidth": {
"publicip_info": [
{
"publicip_id": "29b114d1-2d41-4741-a1f0-b6f80aabceff",
"publicip_type": "5_bgp",
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section8066134"><h4 class="sectiontitle">Response Message</h4><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul45458457"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li54545236">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table58151089155516" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row25417629155516"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p45562050155516"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b532932971">Name</strong></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_apisharedbandwidth_0004__en-us_topic_0201534131_p29734214155516"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1411189807">Type</strong></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_apisharedbandwidth_0004__en-us_topic_0201534131_p59661173155516"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b126114691">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row716877155516"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p58067061155516">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p967638155516"><a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table138718569112">bandwidth</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_apisharedbandwidth_0004__en-us_topic_0201534131_p34319839155516">Specifies the bandwidth objects. For details, see <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table138718569112">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table138718569112"></a><a name="en-us_topic_0201534131_table138718569112"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table138718569112" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1928486977">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row128705614111"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p787856121118"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b393541450">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p2088556181119"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1717864043">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1888115661112"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b468115591">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row1688115611112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p78865651114">name</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1588256131115">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul181211824134816"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li4121152484812">Specifies the bandwidth name.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li16121624114818">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row17881356171113"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p20882056151111">size</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p208855641111">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul19451840174816"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li119459408486">Specifies the bandwidth size.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li594584014815">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 available bandwidth range on the management console.)</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row488105641111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p10881056191119">id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p88816566118">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p48813561118">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row158855661120"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p17881856151120">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p18887564112">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul4262181884915"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li02623188493">Specifies whether the bandwidth is shared or dedicated.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li15262101811497">The value can be <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b10809173018716">PER</strong> or <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1981114301775">WHOLE</strong>.<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul313253512484"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li988283774816"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b56755321579">WHOLE</strong>: Shared bandwidth</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li726221884917"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b35118341875">PER</strong>: Dedicated bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row1089195616112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p88910565118">publicip_info</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p289456141114">Array of <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table51281965">publicip_info</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul14114132894913"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li1711342815491">Specifies information about the EIP that uses the bandwidth. For details, see <a href="#eip_apisharedbandwidth_0004__en-us_topic_0201534131_table51281965">Table 7</a>.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li19114102814917">The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b0778113910241">WHOLE</strong>, can be used by multiple EIPs. The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b16779239162417">PER</strong>, can be used by only one EIP.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row1489156171117"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p489456141120">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p19891756141115">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p19517617121017">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row1089056121112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1989105620112">bandwidth_type</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p158995611110">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul5731955125012"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li373185535019">Specifies the bandwidth type. The default value for the shared bandwidth is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b11237113941913">share</strong>.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row1590155616116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1090356181119">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p69010561114">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul690195631110"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li19901564119">Specifies that the bandwidth is billed by bandwidth.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li89014560111">The value can be <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b842352706191239">traffic</strong>.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row590556151112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p99015567111">billing_info</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1890115614111">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1190145612112">Specifies the bill information.</p>
<p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p414131417317">If <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b534165015199">billing_info</strong> is specified, the bandwidth is in yearly/monthly billing mode.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row457893134810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p36136296490">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p561632984912">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul137091434125111"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li14171113717475">Specifies the enterprise project ID. The value is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1476227203210">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b203158281671">0</strong> indicates the default enterprise project.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li157071534155111">When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.</li></ul>
<div class="note" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534115_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row9477203041814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p16479330181816">status</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p5479163011185">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul114381249113115"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li17438104943116">Specifies the bandwidth status.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li114381349203114">Possible values are as follows:<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul1943874963116"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li14381149113111"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li974172916111"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b53754535164857">NORMAL</strong> (Normal)</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table51281965"></a><a name="en-us_topic_0201534131_table51281965"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_table51281965" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1978344956">publicip_info</strong> objects</caption><thead align="left"><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row26928941"><th align="left" class="cellrowborder" valign="top" width="26.71%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p33760584"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b863514230">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p37114580172552"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1277589726">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.69%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p43944024"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1262714994">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row2696221"><td class="cellrowborder" valign="top" width="26.71%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p17067371">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p53490986172552">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.69%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p3792141220526">Specifies the ID of the EIP that uses the bandwidth.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row963478"><td class="cellrowborder" valign="top" width="26.71%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p621304517467">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p1021574544615">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.69%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p198309316175">Specifies the obtained EIP if only IPv4 EIPs are available. </p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row11195191125518"><td class="cellrowborder" valign="top" width="26.71%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p197308575327">ip_version</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p11730115718326">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.69%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul4257145935817"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li8964173295916">Specifies the IP address version.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li1996423275911">Possible values are as follows:<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul208241936115914"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li12571598588"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b5968529154416">4</strong>: IPv4</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li10628172275910"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_b1535318310449">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_row32534423"><td class="cellrowborder" valign="top" width="26.71%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p18042568">publicip_type</p>
</td>
<td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p42115453172552">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.69%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul13831731151713"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li085013408491_1">Specifies the EIP type.</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li95615391617_1">The value can be <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b5392859182610_1">5_bgp</strong> (Dynamic BGP) or <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b639255918266_1">5_mailbgp</strong> (Mail BGP).</li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li2979182764911_1">Constraints:<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_ul9738153015499_1"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li1385054094914_1">The configured value must be supported by the system. </li><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_li92181231912_1"><strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b1171628102112_1">publicip_id</strong> is an IPv4 port. If <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b178642038112119_1">publicip_type</strong> is not specified, the default value is <strong id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_en-us_topic_0201534274_b819152812216_1">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_ul376984994712"><li id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_li3392864794712">Example response<pre class="screen" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_screen37192145144627">{
"bandwidth": {
"id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
"name": "bandwidth123",
"size": 10,
"share_type": "WHOLE",
"publicip_info": [
{
"publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
"publicip_address": "99.xx.xx.82",
"publicip_type": "5_bgp",
"ip_version": 4
}
],
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"charge_mode": "traffic",
"billing_info": "",
"bandwidth_type": "share",
"status": "NORMAL"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_apisharedbandwidth_0004__en-us_topic_0201534131_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>
View Git Blame Copy Permalink