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>
325 lines
27 KiB
HTML
325 lines
27 KiB
HTML
<a name="vpc_bandwidth_0002"></a><a name="vpc_bandwidth_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying Bandwidths</h1>
|
|
<div id="body49323054"><div class="section" id="vpc_bandwidth_0002__section44718725"><h4 class="sectiontitle">Function</h4><p id="vpc_bandwidth_0002__p35744420">This API is used to query bandwidths using search criteria.</p>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0002__section66924213"><h4 class="sectiontitle">URI</h4><p id="vpc_bandwidth_0002__p1712717542358">GET /v1/{project_id}/bandwidths</p>
|
|
<div class="p" id="vpc_bandwidth_0002__p1146612211362"><a href="#vpc_bandwidth_0002__table62833603">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0002__table62833603"></a><a name="table62833603"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0002__table62833603" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_bandwidth_0002__row55919726"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.2.3.2.2.5.1.1"><p id="vpc_bandwidth_0002__p33203949">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.05%" id="mcps1.3.2.3.2.2.5.1.2"><p id="vpc_bandwidth_0002__p5165373">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.2.3.2.2.5.1.3"><p id="vpc_bandwidth_0002__p59831061171936">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.86%" id="mcps1.3.2.3.2.2.5.1.4"><p id="vpc_bandwidth_0002__p15742086">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0002__row40559"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_bandwidth_0002__p3285280">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_bandwidth_0002__p64781122">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_bandwidth_0002__p14477807171936">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_bandwidth_0002__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row47906786"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_bandwidth_0002__p55244468">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_bandwidth_0002__p45616947">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_bandwidth_0002__p31851746171936">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_bandwidth_0002__p28526205175853">Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.</p>
|
|
<p id="vpc_bandwidth_0002__p538818488578">This parameter can work together with the parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b650614119446">limit</strong>.</p>
|
|
<ul id="vpc_bandwidth_0002__ul12704811125810"><li id="vpc_bandwidth_0002__vpc_api01_0003_li325418407124">If parameters <strong id="vpc_bandwidth_0002__vpc_api01_0003_b736582413514">marker</strong> and <strong id="vpc_bandwidth_0002__vpc_api01_0003_b17435293518">limit</strong> are not passed, resource records on the first page will be returned.</li><li id="vpc_bandwidth_0002__vpc_api01_0003_li1923817171338">If the parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b1505159195414">marker</strong> is not passed and the value of parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b14146122925417">limit</strong> is set to <strong id="vpc_bandwidth_0002__vpc_api01_0003_b13594516546">10</strong>, the first 10 resource records will be returned.</li><li id="vpc_bandwidth_0002__vpc_api01_0003_li2076741203417">If the value of the parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b13589356163415">marker</strong> is set to the resource ID of the 10th record and the value of parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b1557415118357">limit</strong> is set to <strong id="vpc_bandwidth_0002__vpc_api01_0003_b10574171193511">10</strong>, the 11th to 20th resource records will be returned.</li><li id="vpc_bandwidth_0002__vpc_api01_0003_li108512113551">If the value of the parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b9403193716543">marker</strong> is set to the resource ID of the 10th record and the parameter <strong id="vpc_bandwidth_0002__vpc_api01_0003_b10358823165519">limit</strong> is not passed, resource records starting from the 11th records (including 11th) will be returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row19546120"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_bandwidth_0002__p39731869">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_bandwidth_0002__p64164835">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_bandwidth_0002__p29854613171936">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="vpc_bandwidth_0002__p2017153116589">Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.</p>
|
|
<p id="vpc_bandwidth_0002__p125192338584"><strong id="vpc_bandwidth_0002__vpc_api01_0003_b7164124258">limit</strong> can be used together with <strong id="vpc_bandwidth_0002__vpc_api01_0003_b15985310854">marker</strong>. For details, see the parameter description of <strong id="vpc_bandwidth_0002__vpc_api01_0003_b193281854847">marker</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row8134112911534"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="vpc_bandwidth_0002__p55289571029">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="vpc_bandwidth_0002__p15529457128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="vpc_bandwidth_0002__p165291857925">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.3.2.2.5.1.4 "><ul id="vpc_bandwidth_0002__ul152391731105011"><li id="vpc_bandwidth_0002__li1123993155013">Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.</li><li id="vpc_bandwidth_0002__li152395319503">The value is <strong id="vpc_bandwidth_0002__b1442231634111">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="vpc_bandwidth_0002__b1985731920418">0</strong> indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set <strong id="vpc_bandwidth_0002__b32561229284636">all_granted_eps</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ul id="vpc_bandwidth_0002__ul65756648"><li id="vpc_bandwidth_0002__li482155829465">Example request<pre class="screen" id="vpc_bandwidth_0002__screen33535150144521">GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpc_bandwidth_0002__section52152158"><h4 class="sectiontitle">Response Message</h4><ul id="vpc_bandwidth_0002__ul10987981"><li id="vpc_bandwidth_0002__li24283812">Response parameter
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0002__table2569960155435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_bandwidth_0002__row46935377155435"><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_0002__p43669182155435">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_0002__p25764441155435">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_0002__p6544983155435">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0002__row60381654155435"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpc_bandwidth_0002__p59075838155435">bandwidths</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_0002__p42885478155435">Array of <a href="#vpc_bandwidth_0002__table17227723">bandwidths</a> objects</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_0002__p57892147155435">Specifies the bandwidth objects. For details, see <a href="#vpc_bandwidth_0002__table17227723">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0002__table17227723"></a><a name="table17227723"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0002__table17227723" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_bandwidth_0002__b76113042914">bandwidths</strong> field</caption><thead align="left"><tr id="vpc_bandwidth_0002__row57600065"><th align="left" class="cellrowborder" valign="top" width="26.730000000000004%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="vpc_bandwidth_0002__p35093725">Name</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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__p66526832">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0002__row19964345"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul1630720166145"><li id="vpc_bandwidth_0002__li2030721691417">Specifies the bandwidth name.</li><li id="vpc_bandwidth_0002__li2307916111414">The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row11415673"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul1730751620144"><li id="vpc_bandwidth_0002__li1330731661415">Specifies the bandwidth size in Mbit/s.</li><li id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__row24927872"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__p11246416">Specifies the bandwidth ID, which uniquely identifies the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row34108880"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul540194517378"><li id="vpc_bandwidth_0002__li1626115818508">Possible values are as follows:<ul id="vpc_bandwidth_0002__ul1791315517"><li id="vpc_bandwidth_0002__li438892217508"><strong id="vpc_bandwidth_0002__b769791215">PER</strong>: Dedicated bandwidth</li><li id="vpc_bandwidth_0002__li7419195317498"><strong id="vpc_bandwidth_0002__b330995596">WHOLE</strong>: Shared bandwidth</li></ul>
|
|
</li></ul>
|
|
<p id="vpc_bandwidth_0002__p785111375011">If this parameter is not set, the list of all bandwidths will be returned by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row49955752"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__p26395826172022">Array of <a href="#vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul154130570376"><li id="vpc_bandwidth_0002__li9412185715372">Specifies the information about the EIP that uses the bandwidth. For details, see <a href="#vpc_bandwidth_0002__table30936422">Table 4</a>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row12794876"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__p78154550413">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row29288625"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul12723142619163"><li id="vpc_bandwidth_0002__li18723152681614">Specifies the bandwidth type.</li><li id="vpc_bandwidth_0002__li4310192419446">The value can be:<ul id="vpc_bandwidth_0002__ul113101224144419"><li id="vpc_bandwidth_0002__li43107241444"><strong id="vpc_bandwidth_0002__b8573478121">share</strong>: Shared bandwidth</li><li id="vpc_bandwidth_0002__li4927351174410"><strong id="vpc_bandwidth_0002__b837810831214">gray</strong>: Dedicated load balancer</li><li id="vpc_bandwidth_0002__li33117240444"><strong id="vpc_bandwidth_0002__b1168099201213">bgp</strong>: Dynamic BGP</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row58843898173344"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__p1642412810198">If the value is <strong id="vpc_bandwidth_0002__b492435718311">traffic</strong>, the bandwidth is billed by traffic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row43963405568"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__p1886113265557">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="vpc_bandwidth_0002__p886152614551">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="vpc_bandwidth_0002__p9861112645515">Specifies the bill information.</p>
|
|
<p id="vpc_bandwidth_0002__p7765106173214">If <strong id="vpc_bandwidth_0002__b84235270614589">billing_info</strong> is specified, the bandwidth is in yearly/monthly billing mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row12321193185314"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__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="vpc_bandwidth_0002__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="vpc_bandwidth_0002__ul1338863396"><li id="vpc_bandwidth_0002__li123383616395">Specifies the enterprise project ID. The value is <strong id="vpc_bandwidth_0002__b4596948104117">0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value <strong id="vpc_bandwidth_0002__b14938173515414">0</strong> indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set <strong id="vpc_bandwidth_0002__b185061540163015">all_granted_eps</strong>.</li><li id="vpc_bandwidth_0002__li033816133911">When creating a bandwidth, associate the enterprise project ID with the bandwidth.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row48981943163316"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__p1813212463332">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.92%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="vpc_bandwidth_0002__p913274612339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0002__ul1613254663316"><li id="vpc_bandwidth_0002__li713274615337">Specifies the bandwidth status.</li><li id="vpc_bandwidth_0002__li11132946163316">Possible values are as follows:<ul id="vpc_bandwidth_0002__ul613234613312"><li id="vpc_bandwidth_0002__li14381149113111"><strong id="vpc_bandwidth_0002__b84235270610153">FREEZED</strong> (Frozen)</li><li id="vpc_bandwidth_0002__li1438154911315"><strong id="vpc_bandwidth_0002__b53754535164857">NORMAL</strong> (Normal)</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row1634054212284"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__p1996624810283">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="vpc_bandwidth_0002__p129664488284">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0002__ul4323144155310"><li id="vpc_bandwidth_0002__vpc_bandwidth_0001_li6324204113535">Specifies the time (UTC) when the bandwidth is created.</li><li id="vpc_bandwidth_0002__vpc_bandwidth_0001_li1673294335311">Format: <em id="vpc_bandwidth_0002__vpc_bandwidth_0001_i895045134412">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row182104716288"><td class="cellrowborder" valign="top" width="26.730000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="vpc_bandwidth_0002__p10966748162815">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="vpc_bandwidth_0002__p09661484289">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.35000000000001%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><ul id="vpc_bandwidth_0002__ul2245113845517"><li id="vpc_bandwidth_0002__vpc_bandwidth_0001_vpc_bandwidth_0001_li6324204113535">Specifies the time (UTC) when the bandwidth is updated.</li><li id="vpc_bandwidth_0002__vpc_bandwidth_0001_vpc_bandwidth_0001_li1673294335311">Format: <em id="vpc_bandwidth_0002__vpc_bandwidth_0001_i207481465344">yyyy-MM-ddTHH:mm:ss</em></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="vpc_bandwidth_0002__p13519630121716"></p>
|
|
|
|
<div class="tablenoborder"><a name="vpc_bandwidth_0002__table30936422"></a><a name="table30936422"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_bandwidth_0002__table30936422" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="vpc_bandwidth_0002__b221010535">publicip_info</strong> object</caption><thead align="left"><tr id="vpc_bandwidth_0002__row17161430"><th align="left" class="cellrowborder" valign="top" width="25.740000000000002%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="vpc_bandwidth_0002__p47898561">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.5%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="vpc_bandwidth_0002__p2828296517154">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.76%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="vpc_bandwidth_0002__p58761073">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_bandwidth_0002__row62026502"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="vpc_bandwidth_0002__p58090788">publicip_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="vpc_bandwidth_0002__p921881117154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="vpc_bandwidth_0002__p476380">Specifies the ID of the EIP that uses the bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row4287423"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="vpc_bandwidth_0002__p108302031181710">publicip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="vpc_bandwidth_0002__p68300316174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="vpc_bandwidth_0002__p198309316175">Specifies the obtained EIP if only IPv4 EIPs are available. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_bandwidth_0002__row9150720"><td class="cellrowborder" valign="top" width="25.740000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="vpc_bandwidth_0002__p3010817">publicip_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.5%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="vpc_bandwidth_0002__p1953867017154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.76%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><ul id="vpc_bandwidth_0002__ul13831731151713"><li id="vpc_bandwidth_0002__en-us_topic_0020090596_li085013408491">Specifies the EIP type.</li><li id="vpc_bandwidth_0002__en-us_topic_0020090596_li95615391617">The value can be <strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b236112814388">5_bgp</strong> (Dynamic BGP), <strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b11267530143818">5_mailbgp</strong> (Mail BGP), or <strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b14236103853812">5_gray</strong> (Dedicated Load Balancer).</li><li id="vpc_bandwidth_0002__en-us_topic_0020090596_li2979182764911">Constraints:<ul id="vpc_bandwidth_0002__en-us_topic_0020090596_ul9738153015499"><li id="vpc_bandwidth_0002__en-us_topic_0020090596_li1385054094914">The configured value must be supported by the system. </li><li id="vpc_bandwidth_0002__en-us_topic_0020090596_li92181231912"><strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b1171628102112">publicip_id</strong> is an IPv4 port. If <strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b178642038112119">publicip_type</strong> is not specified, the default value is <strong id="vpc_bandwidth_0002__en-us_topic_0020090596_b819152812216">5_bgp</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="vpc_bandwidth_0002__ul5731114894645"><li id="vpc_bandwidth_0002__li4603829094645">Example response<pre class="screen" id="vpc_bandwidth_0002__screen10257559144534">{
|
|
"bandwidths": [
|
|
{
|
|
"id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
|
|
"name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
|
|
"size": 200,
|
|
"share_type": "PER",
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5",
|
|
"publicip_address": "10.xx.xx.3",
|
|
"ip_version": 4,
|
|
"publicip_type": "5_bgp"
|
|
}
|
|
],
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"bandwidth_type": "bgp",
|
|
"charge_mode": "traffic",
|
|
"billing_info": "",
|
|
"enterprise_project_id": "0",
|
|
"status": "NORMAL"
|
|
},
|
|
{
|
|
"id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
|
|
"name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
|
|
"size": 300,
|
|
"share_type": "PER",
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80",
|
|
"publicip_address": "10.xx.xx.9",
|
|
"ip_version": 4,
|
|
"publicip_type": "5_bgp"
|
|
}
|
|
],
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"bandwidth_type": "bgp",
|
|
"charge_mode": "traffic",
|
|
"billing_info": "",
|
|
"enterprise_project_id": "0",
|
|
"status": "NORMAL"
|
|
},
|
|
{
|
|
"id": "0a673f00-3640-4a13-949e-7049b2916baf",
|
|
"name": "bandwidth123",
|
|
"size": 10,
|
|
"share_type": "PER",
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc",
|
|
"publicip_address": "10.xx.xx.184",
|
|
"ip_version": 4,
|
|
"publicip_type": "5_bgp"
|
|
}
|
|
],
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"bandwidth_type": "bgp",
|
|
"charge_mode": "traffic",
|
|
"billing_info": "",
|
|
"enterprise_project_id": "0",
|
|
"status": "NORMAL"
|
|
},
|
|
{
|
|
"id": "0dde1eae-1783-46dc-998c-930fbe261ff9",
|
|
"name": "bandwidth123",
|
|
"size": 100,
|
|
"share_type": "PER",
|
|
"publicip_info": [
|
|
{
|
|
"publicip_id": "24232038-e178-40ad-80e4-5abb75db84be",
|
|
"publicip_address": "10.xx.xx.101",
|
|
"ip_version": 4,
|
|
"publicip_type": "5_bgp"
|
|
}
|
|
],
|
|
"tenant_id": "26ae5181a416420998eb2093aaed84d9",
|
|
"bandwidth_type": "bgp",
|
|
"charge_mode": "traffic",
|
|
"billing_info": "",
|
|
"enterprise_project_id": "0",
|
|
"status": "NORMAL"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_bandwidth_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_bandwidth_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_bandwidth_0002__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>
|
|
|