forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
245 lines
22 KiB
HTML
245 lines
22 KiB
HTML
<a name="vpc_bandwidth_0001"></a><a name="vpc_bandwidth_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Bandwidth</h1>
|
|
<div id="body35228531"><div class="section" id="vpc_bandwidth_0001__section65488131"><h4 class="sectiontitle">Function</h4><p id="vpc_bandwidth_0001__p34938791">This API is used to query details about a bandwidth.</p>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0001__section52522275"><h4 class="sectiontitle">URI</h4><p id="vpc_bandwidth_0001__p99473062818">GET /v1/{project_id}/bandwidths/{bandwidth_id}</p>
|
|
<div class="p" id="vpc_bandwidth_0001__p1520419284014"><a href="#vpc_bandwidth_0001__table40002310">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0001__table40002310"></a><a name="table40002310"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0001__table40002310" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_bandwidth_0001__row55023063"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpc_bandwidth_0001__p27683123">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="vpc_bandwidth_0001__p27740487">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="vpc_bandwidth_0001__p32387004">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0001__row6101690"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_bandwidth_0001__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="vpc_bandwidth_0001__p36306286">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_bandwidth_0001__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row26390432"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p57250251">bandwidth_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p6758730">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_bandwidth_0001__p10586246">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0001__section2938434"><h4 class="sectiontitle">Request Message</h4><ul id="vpc_bandwidth_0001__ul52179558"><li id="vpc_bandwidth_0001__li55280873">Request parameter<p id="vpc_bandwidth_0001__p0667231182613"><a name="vpc_bandwidth_0001__li55280873"></a><a name="li55280873"></a>None</p>
|
|
</li><li id="vpc_bandwidth_0001__li5117517294538">Example request<pre class="screen" id="vpc_bandwidth_0001__screen125561623112217">Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0001__section26445914"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_bandwidth_0001__ul34438257"><li id="vpc_bandwidth_0001__li6774674">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0001__table16054594155348" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_bandwidth_0001__row50617932155348"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpc_bandwidth_0001__p6411865155348">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="vpc_bandwidth_0001__p58099771155348">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="vpc_bandwidth_0001__p8461025155348">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0001__row14254431155348"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_bandwidth_0001__p13758302155348">bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpc_bandwidth_0001__p6803198155348"><a href="#vpc_bandwidth_0001__table60972066">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="vpc_bandwidth_0001__p60584419155348">Specifies the bandwidth object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0001__table60972066"></a><a name="table60972066"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0001__table60972066" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_bandwidth_0001__b7652101419817">bandwidth</strong> field</caption><thead align="left"><tr id="vpc_bandwidth_0001__row10740297"><th align="left" class="cellrowborder" valign="top" width="25.28%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_bandwidth_0001__p64657722">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.96%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="vpc_bandwidth_0001__p48285594171334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.760000000000005%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="vpc_bandwidth_0001__p24185120">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0001__row12837735"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p33223577">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p18819060171334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul144011136327"><li id="vpc_bandwidth_0001__li94011737326">Specifies the bandwidth name.</li><li id="vpc_bandwidth_0001__li114011532322">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row61765553"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p36953931">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p47948882171334">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul334719207325"><li id="vpc_bandwidth_0001__li12347420153220">Specifies the bandwidth size.</li><li id="vpc_bandwidth_0001__li934732023214">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="vpc_bandwidth_0001__row63416368"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p36452220">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p58654237171334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_bandwidth_0001__p17440495">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row22746728"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p30545685">share_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p53372732171334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul26455237335"><li id="vpc_bandwidth_0001__li351316453497">Possible values are as follows:<ul id="vpc_bandwidth_0001__ul18934135414495"><li id="vpc_bandwidth_0001__li438892217508"><strong id="vpc_bandwidth_0001__b842352706204716">PER</strong>: Dedicated bandwidth</li><li id="vpc_bandwidth_0001__li7419195317498"><strong id="vpc_bandwidth_0001__b842352706204729">WHOLE</strong>: Shared bandwidth</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row51058985"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p42137138">publicip_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p26395826172022">Array of <a href="#vpc_bandwidth_0001__table30936422">publicip_info</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul187519405337"><li id="vpc_bandwidth_0001__li13851134310333">Specifies information about the EIP that uses the bandwidth. For details, see <a href="#vpc_bandwidth_0001__table30936422">Table 4</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row36079911"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p36791668">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p4444568171334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_bandwidth_0001__p61029421345">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row8730397"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p36073588">bandwidth_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p24465700171334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul6910164734619"><li id="vpc_bandwidth_0001__li1891034774613">Specifies the bandwidth type.</li><li id="vpc_bandwidth_0001__li4310192419446">The value can be:<ul id="vpc_bandwidth_0001__ul113101224144419"><li id="vpc_bandwidth_0001__li43107241444"><strong id="vpc_bandwidth_0001__b389515332111">share</strong>: Shared bandwidth</li><li id="vpc_bandwidth_0001__li4927351174410"><strong id="vpc_bandwidth_0001__b2442144014116">gray</strong>: Dedicated load balancer</li><li id="vpc_bandwidth_0001__li33117240444"><strong id="vpc_bandwidth_0001__b79561335121115">bgp</strong>: Dynamic BGP</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row2300081817338"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p3464166173311">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p45598234173311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 ">
|
|
<p id="vpc_bandwidth_0001__p109151562174">If the value is <strong id="vpc_bandwidth_0001__b13611135114303">traffic</strong>, the billing is based on traffic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row186022695519"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p1886113265557">billing_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p886152614551">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_bandwidth_0001__p9861112645515">Specifies the bill information.</p>
|
|
<p id="vpc_bandwidth_0001__p365675853113">If <strong id="vpc_bandwidth_0001__b84235270614589">billing_info</strong> is specified, the bandwidth is in yearly/monthly billing mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row1394517484519"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p36136296490">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p561632984912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul95471142193419"><li id="vpc_bandwidth_0001__li695516816174">Specifies the enterprise project ID. The value is <strong id="vpc_bandwidth_0001__b1234564516406">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-).</li><li id="vpc_bandwidth_0001__li05471842133418">When creating a bandwidth, associate the enterprise project ID with the bandwidth.</li><li id="vpc_bandwidth_0001__li693561319371">If this parameter is not specified, the default value is <strong id="vpc_bandwidth_0001__b844113520515">0</strong>, which indicates that the default enterprise project is used.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row915144611317"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p6438749153119">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p1843814491317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul114381249113115"><li id="vpc_bandwidth_0001__li17438104943116">Specifies the bandwidth status.</li><li id="vpc_bandwidth_0001__li114381349203114">Possible values are as follows:<ul id="vpc_bandwidth_0001__ul1943874963116"><li id="vpc_bandwidth_0001__li14381149113111"><strong id="vpc_bandwidth_0001__b84235270610153">FREEZED</strong> (Frozen)</li><li id="vpc_bandwidth_0001__li1438154911315"><strong id="vpc_bandwidth_0001__b53754535164857">NORMAL</strong> (Normal)</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row1527743013159"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p06731737121512">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p26731437161510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul4323144155310"><li id="vpc_bandwidth_0001__li6324204113535">Specifies the time (UTC) when the bandwidth is created.</li><li id="vpc_bandwidth_0001__li1673294335311">Format: <em id="vpc_bandwidth_0001__i895045134412">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row775316357153"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0001__p17673123731516">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.96%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0001__p167383721517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.760000000000005%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul2245113845517"><li id="vpc_bandwidth_0001__vpc_bandwidth_0001_li6324204113535">Specifies the time (UTC) when the bandwidth is updated.</li><li id="vpc_bandwidth_0001__vpc_bandwidth_0001_li1673294335311">Format: <em id="vpc_bandwidth_0001__i207481465344">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0001__table30936422"></a><a name="table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0001__table30936422" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_bandwidth_0001__b2532171795227">publicip_info</strong> object</caption><thead align="left"><tr id="vpc_bandwidth_0001__row17161430"><th align="left" class="cellrowborder" valign="top" width="25.740000000000002%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="vpc_bandwidth_0001__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="vpc_bandwidth_0001__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="vpc_bandwidth_0001__p58761073">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0001__row62026502"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_bandwidth_0001__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="vpc_bandwidth_0001__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="vpc_bandwidth_0001__p14562133572615">Specifies the ID of the EIP that uses the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row4287423"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_bandwidth_0001__p11736974">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="vpc_bandwidth_0001__p852626317154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="vpc_bandwidth_0001__p23386368">Specifies the obtained EIP if only IPv4 EIPs are available. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row831914452324"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_bandwidth_0001__p197308575327">ip_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="vpc_bandwidth_0001__p11730115718326">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><ul id="vpc_bandwidth_0001__ul4257145935817"><li id="vpc_bandwidth_0001__li8964173295916">Specifies the IP address version.</li><li id="vpc_bandwidth_0001__li1996423275911">Possible values are as follows:<ul id="vpc_bandwidth_0001__ul208241936115914"><li id="vpc_bandwidth_0001__li12571598588"><strong id="vpc_bandwidth_0001__b280913261217">4</strong>: IPv4</li><li id="vpc_bandwidth_0001__li10628172275910"><strong id="vpc_bandwidth_0001__b12610103583">6</strong>: IPv6 (IPv6 is not supported currently.)</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0001__row9150720"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="vpc_bandwidth_0001__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="vpc_bandwidth_0001__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="vpc_bandwidth_0001__ul11964539104914"><li id="vpc_bandwidth_0001__en-us_topic_0020090596_li085013408491">Specifies the EIP type.</li><li id="vpc_bandwidth_0001__en-us_topic_0020090596_li95615391617">The value can be <strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b236112814388">5_bgp</strong> (Dynamic BGP), <strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b11267530143818">5_mailbgp</strong> (Mail BGP), or <strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b14236103853812">5_gray</strong> (Dedicated Load Balancer).</li><li id="vpc_bandwidth_0001__en-us_topic_0020090596_li2979182764911">Constraints:<ul id="vpc_bandwidth_0001__en-us_topic_0020090596_ul9738153015499"><li id="vpc_bandwidth_0001__en-us_topic_0020090596_li1385054094914">The configured value must be supported by the system. </li><li id="vpc_bandwidth_0001__en-us_topic_0020090596_li92181231912"><strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="vpc_bandwidth_0001__en-us_topic_0020090596_b819152812216">5_bgp</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="vpc_bandwidth_0001__ul1533222494552"><li id="vpc_bandwidth_0001__li377228994552">Example response<pre class="screen" id="vpc_bandwidth_0001__screen136212403715">{
|
|
"bandwidth": {
|
|
"id": "3cbd5ae9-368f-4bc8-8841-f2ecc322c64a",
|
|
"name": "EIPResourceSetup_1553594229",
|
|
"size": 5,
|
|
"share_type": "PER",
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "22b02f40-b95f-465a-ae9b-7c8b0f042a41",
|
|
"publicip_address": "10.xx.xx.62",
|
|
"ip_version": 4,
|
|
"publicip_type": "5_bgp",
|
|
}
|
|
],
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"bandwidth_type": "bgp",
|
|
"charge_mode": "traffic",
|
|
"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="vpc_bandwidth_0001__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_bandwidth_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_bandwidth_0001__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_bandwidth_0000.html">Bandwidth</a></div>
|
|
</div>
|
|
</div>
|
|
|