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

300 lines
33 KiB
HTML
Raw Blame History

<a name="eip_apiBandwidth_0003"></a><a name="eip_apiBandwidth_0003"></a>
<h1 class="topictitle1">Updating a Bandwidth</h1>
<div id="body8662426"><div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section16581154"><h4 class="sectiontitle">Function</h4><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p28896937">This API is used to update information about a bandwidth.</p>
</div>
<div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section15012662"><h4 class="sectiontitle">URI</h4><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p442916004016">PUT /v1/{project_id}/bandwidths/{bandwidth_id}</p>
<div class="p" id="eip_apiBandwidth_0003__en-us_topic_0201534310_p5203226204018"><a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table25281875">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="eip_apiBandwidth_0003__en-us_topic_0201534310_table25281875"></a><a name="en-us_topic_0201534310_table25281875"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table25281875" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row26712487"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p16227847">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p39387211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p36247516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row50367649"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p10487112">Specifies the project ID. </p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row41709209"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p60287683">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section896237"><h4 class="sectiontitle">Request Message</h4><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul51464189"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li3539410">Request parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table3057854815556" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p5903494715556">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1710139915556">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.380000000000003%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p4303610815556">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.47%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p6337274615556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row3291877615556"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p4917516615556">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p2376550915556">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.380000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p4595806815556"><a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table31854691">bandwidth</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="39.47%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1610901815556">Specifies the bandwidth objects. For details, see <a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table31854691">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apiBandwidth_0003__en-us_topic_0201534310_table31854691"></a><a name="en-us_topic_0201534310_table31854691"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table31854691" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong>bandwidth</strong> field</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p20640979">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.17%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p61306625">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.229999999999999%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p5200653172316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.25%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p66889567">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row49345813"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p37587916">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p24722347">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p18599757172316">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul5677198174113"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li76777834113">Specifies the bandwidth name.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li186771582412">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). If the value is left blank, the name of the bandwidth is not changed.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li2067788184116">Either parameter <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b84235270621475">name</strong> or <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b84235270621478">size</strong> must be specified.</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row10796581"><td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p2107829">size</p>
</td>
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p36516433">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p30185329172316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1396719655311"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li115863424114">Specifies the bandwidth size in Mbit/s.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1458193418418">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.) If the parameter is not included, the bandwidth size is not changed.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li058203424114">Either parameter <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b159295748">name</strong> or <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b801338896">size</strong> must be specified.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li69671462539">If a decimal fraction (for example <strong>10.2</strong>) or a character string (for example <strong>"10"</strong>) is specified, the specified value will be automatically converted to an integer.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li20468132545311">The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul9790510185"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_li147907100814">The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul97325109472"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li204837269472">Example request<pre class="screen" id="eip_apiBandwidth_0003__en-us_topic_0201534310_screen47283213144618">PUT https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id}
{
"bandwidth":
{"name": "bandwidth123",
"size": 10
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section8066134"><h4 class="sectiontitle">Response Message</h4><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul45458457"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li54545236">Response parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table58151089155516" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p45562050155516">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p29734214155516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p59661173155516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row716877155516"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0003__en-us_topic_0201534310_p967638155516"><a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table17227723">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_apiBandwidth_0003__en-us_topic_0201534310_p34319839155516">Specifies the bandwidth objects. For details, see <a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table17227723">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apiBandwidth_0003__en-us_topic_0201534310_table17227723"></a><a name="en-us_topic_0201534310_table17227723"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table17227723" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of the <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b76113042914">bandwidth</strong> field</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row57600065"><th align="left" class="cellrowborder" valign="top" width="26.730000000000004%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p35093725"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b1051561924911">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.92%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p42606680172022">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.35000000000001%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p66526832">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row19964345"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p6499254">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p28589065172022">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1630720166145"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li2030721691417">Specifies the bandwidth name.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li2307916111414">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row11415673"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p52254296">size</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p34012930172022">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1730751620144"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1330731661415">Specifies the bandwidth size in Mbit/s.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li10307171618147">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.)</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row24927872"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p5891777">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p3583980172022">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p11246416">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row34108880"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p11355891">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p21866991172022">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul540194517378"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1626115818508">Possible values are as follows:<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1791315517"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1518410531198"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b842352706204716">PER</strong>: Dedicated bandwidth</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li10184175318191"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b842352706204729">WHOLE</strong>: Shared bandwidth</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row49955752"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p19884118">publicip_info</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p26395826172022">Array of <a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table30936422">publicip_info</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul154130570376"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li9412185715372">Specifies the information about the EIP that uses the bandwidth. For details, see <a href="#eip_apiBandwidth_0003__en-us_topic_0201534310_table30936422">Table 6</a>.</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row12794876"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p29752015">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p57687133172022">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1539621310512">Specifies the project ID.</p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row29288625"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p23568445">bandwidth_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p42146201172022">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul12723142619163"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li18723152681614">Specifies the bandwidth type.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li740220562019">The value can be <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b1560654322413">bgp</strong> or <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b1560624318249">share</strong>.<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul4402655202"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li134027512207"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b12971944152420">share</strong>: Shared bandwidth</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li440220517202"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b1748546192415">bgp</strong>: Dynamic BGP</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row58843898173344"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p18916883173347">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p29386093173347">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 ">
<p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1028732893412">If the value is <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b164011341133220">traffic</strong>, the bandwidth is billed by traffic.</p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row43963405568"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p918520532192">billing_info</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p161861532196">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p20186185331911">Specifies the bill information.</p>
<p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p7765106173214">If <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b84235270614589">billing_info</strong> is specified, the bandwidth is in yearly/monthly billing mode.</p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row12321193185314"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p36136296490">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p561632984912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1338863396"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li123383616395">Specifies the enterprise project ID. The value is <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b1852105916411">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b3967191144218">0</strong> indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b185061540163015">all_granted_eps</strong>.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li033816133911">When creating a bandwidth, associate the enterprise project ID with the bandwidth.</li></ul>
<div class="note" id="eip_apiBandwidth_0003__en-us_topic_0201534310_note19041412125118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534275_p182751511487">This parameter is unsupported. Do not use it.</p>
</div></div>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row13411105163416"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p787501511342">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1187541510340">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul087531573419"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1787511553416">Specifies the bandwidth status.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li2875815123420">Possible values are as follows:<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul148751315143413"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li1087517158340"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b395851153719">FREEZED</strong> (Frozen)</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li6875151533413"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b17160414113714">NORMAL</strong> (Normal)</li></ul>
</li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row14491814183414"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p16875171513346">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p178752159344">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul4323144155310"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534167_li6324204113535">Specifies the time (UTC) when the bandwidth is created.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534167_li1673294335311">Format: <em id="eip_apiBandwidth_0003__en-us_topic_0201534310_i31375292620">yyyy-MM-ddTHH:mm:ss</em></li></ul>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row10245101013344"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1387518158342">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p9875015133415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul1197916281775"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534167_en-us_topic_0201534167_li6324204113535">Specifies the time (UTC) when the bandwidth is updated.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534167_en-us_topic_0201534167_li1673294335311">Format: <em id="eip_apiBandwidth_0003__en-us_topic_0201534310_i64812710267">yyyy-MM-ddTHH:mm:ss</em></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="eip_apiBandwidth_0003__en-us_topic_0201534310_table30936422"></a><a name="en-us_topic_0201534310_table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="eip_apiBandwidth_0003__en-us_topic_0201534310_table30936422" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_b51948857105640">publicip_info</strong> objects</caption><thead align="left"><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row17161430"><th align="left" class="cellrowborder" valign="top" width="25.740000000000002%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p47898561">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.5%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p2828296517154">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.76%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p58761073">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row62026502"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p58090788">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p921881117154">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p476380">Specifies the ID of the EIP that uses the bandwidth.</p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row4287423"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p108302031181710">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p68300316174">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p198309316175">Specifies the obtained EIP if only IPv4 EIPs are available. </p>
</td>
</tr>
<tr id="eip_apiBandwidth_0003__en-us_topic_0201534310_row9150720"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p3010817">publicip_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p1953867017154">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul13831731151713"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_li085013408491">Specifies the EIP type.</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_li95615391617">The value can be <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_b5392859182610">5_bgp</strong> (Dynamic BGP) or <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_b639255918266">5_mailbgp</strong> (Mail BGP).</li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_li2979182764911">Constraints:<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_ul9738153015499"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_li1385054094914">The configured value must be supported by the system. </li><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_li92181231912"><strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="eip_apiBandwidth_0003__en-us_topic_0201534310_en-us_topic_0201534274_b819152812216">5_bgp</strong>.</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="eip_apiBandwidth_0003__en-us_topic_0201534310_ul376984994712"><li id="eip_apiBandwidth_0003__en-us_topic_0201534310_li3392864794712">Example response<pre class="screen" id="eip_apiBandwidth_0003__en-us_topic_0201534310_screen37192145144627">{
"bandwidth": {
"id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
"name": "bandwidth123",
"size": 10,
"share_type": "PER",
"publicip_info": [
{
"publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
"publicip_address": "161.xx.xx.9",
"publicip_type": "5_bgp",
"ip_version": 4
}
],
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
"bandwidth_type": "bgp",
"charge_mode": "traffic",
"billing_info": "",
"status": "NORMAL"
}
}</pre>
</li></ul>
</div>
<div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section31981619"><h4 class="sectiontitle">Status Code</h4><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_p18112112662914">See <a href="eip_api05_0001.html#eip_api05_0001">Status Codes</a>.</p>
</div>
<div class="section" id="eip_apiBandwidth_0003__en-us_topic_0201534310_section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="eip_apiBandwidth_0003__en-us_topic_0201534310_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_apiBandwidth_0000.html">Bandwidth</a></div>
</div>
</div>
View Git Blame Copy Permalink