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

299 lines
37 KiB
HTML
Raw Blame History

<a name="eip_apisharedbandwidth_0001"></a><a name="eip_apisharedbandwidth_0001"></a>
<h1 class="topictitle1">Assigning a Shared Bandwidth</h1>
<div id="body8662426"><div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section65488131"><h4 class="sectiontitle">Function</h4><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p34938791">This API is used to assign a shared bandwidth.</p>
</div>
<div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section52522275"><h4 class="sectiontitle">URI</h4><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p114911364451">POST /v2.0/{project_id}/bandwidths</p>
<div class="p" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p14190339154016"><a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table40002310">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table40002310"></a><a name="en-us_topic_0201534115_table40002310"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table40002310" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row55023063"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p27683123"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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_0001__en-us_topic_0201534115_p27740487"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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_0001__en-us_topic_0201534115_p32387004"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b8423527061645">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row6101690"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p24474856">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_0001__en-us_topic_0201534115_p36306286">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_0001__en-us_topic_0201534115_p10487112">Specifies the project ID. </p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section1838275013814"><h4 class="sectiontitle">Request Message</h4><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul53872188"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li14140023">Request parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table62031189151043" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row4339910151043"><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_0001__en-us_topic_0201534115_p15988448151043"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1364975295">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_0001__en-us_topic_0201534115_p19995902151043"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b621533855">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_0001__en-us_topic_0201534115_p9055369151043"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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_0001__en-us_topic_0201534115_p62396264151043"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b102882430">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row13560713151050"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p24675975151050">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_0001__en-us_topic_0201534115_p52596998151050">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_0001__en-us_topic_0201534115_p12429959151120"><a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table11041789">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_0001__en-us_topic_0201534115_p1744019151120">Specifies the bandwidth objects. For details, see <a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table11041789">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table11041789"></a><a name="en-us_topic_0201534115_table11041789"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table11041789" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b17968148162517">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row60677888"><th align="left" class="cellrowborder" valign="top" width="24.797520247975203%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p15961928"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1515343789">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.038896110388961%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p17847776"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b405784034">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.57874212578742%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p3784029918155"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1604851586">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.584841515848424%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36383728"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b308842528">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row61400865"><td class="cellrowborder" valign="top" width="24.797520247975203%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p7414170">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.038896110388961%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p1525924410101">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.57874212578742%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p4516535118155">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.584841515848424%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul765710205595"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li06573208593">Specifies the bandwidth name.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li6323723105911">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row15772917"><td class="cellrowborder" valign="top" width="24.797520247975203%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p2537905">size</p>
</td>
<td class="cellrowborder" valign="top" width="11.038896110388961%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p4243749">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.57874212578742%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p3451484018155">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.584841515848424%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul9790510185"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li7554028134712">Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li2554192816476">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><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li1673520485715">If a decimal fraction (for example <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b13410112711294">10.2</strong>) or a character string (for example <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b10417627102918">"10"</strong>) is specified, the specified value will be automatically converted to an integer.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li177351744578">The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul8496121414572"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li117904102081">The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li779011105810">The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li147907100814">The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row635318555442"><td class="cellrowborder" valign="top" width="24.797520247975203%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p935375544419">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.038896110388961%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p9353115594417">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.57874212578742%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p835335513446">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.584841515848424%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul10593183910472"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li1959343924718">Specifies the enterprise project ID. The value is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1365248144217">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b6187151118427">0</strong> indicates the default enterprise project.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li145933391479">When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.</li></ul>
<div class="note" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul4600869594349"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li1142507994349">Example request<pre class="screen" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_screen56409399144156">POST <em id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_i8709236181913"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b370933641916"></strong></em>https://{Endpoint}/v2.0/{project_id}/bandwidths
{
"bandwidth": {
"name": "bandwidth123",
"size": 10,
"enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439"
}
}</pre>
</li></ul>
<div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section1412808"><h4 class="sectiontitle">Response Message</h4><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul34438257"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li6774674">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table16054594155348" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row50617932155348"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p6411865155348"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b2031577315">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p58099771155348"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1810610453">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p8461025155348"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1115687285">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row14254431155348"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p13758302155348">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p6803198155348"><a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table60972066">bandwidth</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p60584419155348">Specifies the bandwidth objects. For details, see <a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table60972066">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table60972066"></a><a name="en-us_topic_0201534115_table60972066"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table60972066" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of the <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b149867813255">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row10740297"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p64657722"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1705588697">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p48285594171334"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b778606261">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p24185120"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1817013921">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row12837735"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p33223577">name</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p18819060171334">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul181211824134816"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li4121152484812">Specifies the bandwidth name.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li16121624114818">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row61765553"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36953931">size</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p47948882171334">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul19451840174816"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li119459408486">Specifies the bandwidth size.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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_0001__en-us_topic_0201534115_row63416368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36452220">id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p58654237171334">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p17440495">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row22746728"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p30545685">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p53372732171334">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul4262181884915"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li02623188493">Specifies whether the bandwidth is shared or dedicated.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li15262101811497">The value can be <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b49905822519">PER</strong> or <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b5990389257">WHOLE</strong>.<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul313253512484"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li988283774816"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b16682925181913">WHOLE</strong>: Shared bandwidth</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li726221884917"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b154451296198">PER</strong>: Dedicated bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row51058985"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p42137138">publicip_info</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p28224024171334">Array of <a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table30936422">publicip_info</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul14114132894913"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li1711342815491">Specifies information about the EIP that uses the bandwidth. For details, see <a href="#eip_apisharedbandwidth_0001__en-us_topic_0201534115_table30936422">Table 6</a>.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li19114102814917">The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b16483815202">WHOLE</strong>, can be used by multiple EIPs. The bandwidth, whose type is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b128211741182018">PER</strong>, can be used by only one EIP.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row36079911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36791668">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p4444568171334">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p16528103118518">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row8730397"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36073588">bandwidth_type</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p24465700171334">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul5731955125012"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li373185535019">Specifies the bandwidth type. The default value for the shared bandwidth is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b750936389173824">share</strong>.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row2300081817338"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p3464166173311">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p45598234173311">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul193819183512"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li16571143684815">Specifies that the bandwidth is billed by bandwidth.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li16728145144815">The value can be <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b842352706191239">traffic</strong>.</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row186022695519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p1886113265557">billing_info</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p886152614551">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p9861112645515">Specifies the bill information.</p>
<p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p414131417317">If <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b84235270614589">billing_info</strong> is specified, the bandwidth is in yearly/monthly billing mode.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row457893134810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p36136296490">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p561632984912">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul137091434125111"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li20159171619478">Specifies the enterprise project ID. The value is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b161197501857">0</strong> or a UUID that can contain a maximum of 36 characters, including hyphens (-). Value <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b284745764216">0</strong> indicates the default enterprise project.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li157071534155111">When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.</li></ul>
<div class="note" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_note733815485581"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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_0001__en-us_topic_0201534115_row9477203041814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p16479330181816">status</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p5479163011185">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul114381249113115"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li17438104943116">Specifies the bandwidth status.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li114381349203114">Possible values are as follows:<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul1943874963116"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li14381149113111"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b84235270610153">FREEZED</strong> (Frozen)</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li974172916111"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b53754535164857">NORMAL</strong> (Normal)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row952115219374"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p1740745993716">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p340715913718">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul2245113845517"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_li6324204113535">Specifies the time (UTC) when the bandwidth is created.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_li1673294335311">Format: <em id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_i895045134412">yyyy-MM-ddTHH:mm:ss</em></li></ul>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row69461857103718"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p9408459123717">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p0408559183711">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul3630906584"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_en-us_topic_0201534167_li6324204113535">Specifies the time (UTC) when the bandwidth is updated.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_en-us_topic_0201534167_li1673294335311">Format: <em id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534167_i207481465344">yyyy-MM-ddTHH:mm:ss</em></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table30936422"></a><a name="en-us_topic_0201534115_table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_table30936422" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b51948857105640">publicip_info</strong> object</caption><thead align="left"><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row17161430"><th align="left" class="cellrowborder" valign="top" width="25.740000000000002%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p47898561"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1557789794">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.5%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p2828296517154"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b979331436">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.76%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p58761073"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_b1194895997">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row62026502"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p58090788">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p921881117154">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p3792141220526">Specifies the ID of the EIP that uses the bandwidth.</p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row1565124218464"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p621304517467">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p1021574544615">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p198309316175">Specifies the obtained EIP if only IPv4 EIPs are available. </p>
</td>
</tr>
<tr id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_row9150720"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p3010817">publicip_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p1953867017154">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul13831731151713"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_ul9738153015499"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_li92181231912"><strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_ul1533222494552"><li id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_li377228994552">Example response<pre class="screen" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_screen12286881144458">{
"bandwidth": {
"id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387",
"name": "bandwidth123",
"size": 10,
"share_type": "WHOLE",
"publicip_info": [],
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
"bandwidth_type": "share",
"charge_mode": "traffic",
"billing_info": "",
"enterprise_project_id": "0",
"status": "NORMAL",
"created_at": "2020-04-21T07:58:02Z",
"updated_at": "2020-04-21T07:58:02Z"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_apisharedbandwidth_0001__en-us_topic_0201534115_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