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>
238 lines
19 KiB
HTML
238 lines
19 KiB
HTML
<a name="vpc_quota_0001"></a><a name="vpc_quota_0001"></a>
|
|
|
|
<h1 class="topictitle1">Querying Quotas</h1>
|
|
<div id="body27450972"><div class="section" id="vpc_quota_0001__section52301286"><h4 class="sectiontitle">Function</h4><p id="vpc_quota_0001__p8936292">This API is used to query network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, and VPNs.</p>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section949529"><h4 class="sectiontitle">URI</h4><p id="vpc_quota_0001__p97921941196">GET /v1/{project_id}/quotas</p>
|
|
<div class="p" id="vpc_quota_0001__p51111276194">Example:<pre class="screen" id="vpc_quota_0001__screen12303961144645">GET https://{Endpoint}/v1/{project_id}/quotas?type={type}</pre>
|
|
</div>
|
|
<div class="p" id="vpc_quota_0001__p367301191914"><a href="#vpc_quota_0001__table38014313">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_quota_0001__table38014313"></a><a name="table38014313"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_quota_0001__table38014313" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_quota_0001__row46663997"><th align="left" class="cellrowborder" valign="top" width="18.8%" id="mcps1.3.2.4.2.2.5.1.1"><p id="vpc_quota_0001__p21687383">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.2.4.2.2.5.1.2"><p id="vpc_quota_0001__p11847581">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.2.4.2.2.5.1.3"><p id="vpc_quota_0001__p18682156172640">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.86%" id="mcps1.3.2.4.2.2.5.1.4"><p id="vpc_quota_0001__p20130041">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_quota_0001__row19920592"><td class="cellrowborder" valign="top" width="18.8%" headers="mcps1.3.2.4.2.2.5.1.1 "><p id="vpc_quota_0001__p2955276">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.4.2.2.5.1.2 "><p id="vpc_quota_0001__p38050837">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.2.4.2.2.5.1.3 "><p id="vpc_quota_0001__p36859696172640">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.4.2.2.5.1.4 "><p id="vpc_quota_0001__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_quota_0001__row23099752"><td class="cellrowborder" valign="top" width="18.8%" headers="mcps1.3.2.4.2.2.5.1.1 "><p id="vpc_quota_0001__p59140623">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.4.2.2.5.1.2 "><p id="vpc_quota_0001__p25661150">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.2.4.2.2.5.1.3 "><p id="vpc_quota_0001__p32845400172640">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.86%" headers="mcps1.3.2.4.2.2.5.1.4 "><ul id="vpc_quota_0001__ul1167716476142"><li id="vpc_quota_0001__li1767724712142">Specifies the resource type.</li><li id="vpc_quota_0001__li7625114921413">Values:<ul id="vpc_quota_0001__ul9961151312919"><li id="vpc_quota_0001__li99111844123411"><strong id="vpc_quota_0001__b14549171332919">vpc</strong>: VPC</li><li id="vpc_quota_0001__li2961113172920"><strong id="vpc_quota_0001__b18886233182919">subnet</strong>: Subnet</li><li id="vpc_quota_0001__li3961141342914"><strong id="vpc_quota_0001__b74529492296">securityGroup</strong>: Security group</li><li id="vpc_quota_0001__li396171322915"><strong id="vpc_quota_0001__b17924155813295">securityGroupRule</strong>: Security group rule</li><li id="vpc_quota_0001__li15961151313295"><strong id="vpc_quota_0001__b49801311133018">publicIp</strong>: <span id="vpc_quota_0001__text1857544105311"></span><span id="vpc_quota_0001__text5575154115319">EIP</span></li><li id="vpc_quota_0001__li14961181382917"><strong id="vpc_quota_0001__b12131417103019">vpn</strong>: VPN</li><li id="vpc_quota_0001__li15961713112912"><strong id="vpc_quota_0001__b373014367304">vpcPeer</strong>: VPC peering connection</li><li id="vpc_quota_0001__li196114133292"><strong id="vpc_quota_0001__b19659765313">loadbalancer</strong>: Load balancer</li><li id="vpc_quota_0001__li1996171318294"><strong id="vpc_quota_0001__b19332143620498">listener</strong>: Load balancer listener</li><li id="vpc_quota_0001__li89611613172916"><strong id="vpc_quota_0001__b959714433515">physicalConnect</strong>: Direct Connect connection</li><li id="vpc_quota_0001__li7961151312910"><strong id="vpc_quota_0001__b19988164645318">virtualInterface</strong>: Virtual interface</li><li id="vpc_quota_0001__li1696111382920"><strong id="vpc_quota_0001__b16211487533">firewall</strong>: Firewall</li><li id="vpc_quota_0001__li29617137299"><strong id="vpc_quota_0001__b11145638145419">shareBandwidthIP</strong>: IP address added to a shared bandwidth</li><li id="vpc_quota_0001__li49613134298"><strong id="vpc_quota_0001__b13994435545">shareBandwidth</strong>: Shared bandwidth</li><li id="vpc_quota_0001__li129611813122917"><strong id="vpc_quota_0001__b3284153319554">address_group</strong>: IP address group</li><li id="vpc_quota_0001__li7614113763211"><strong id="vpc_quota_0001__b1485105895518">flow_log</strong>: VPC fow log</li><li id="vpc_quota_0001__li10868104283219"><strong id="vpc_quota_0001__b580115451566">vpcContainRoutetable</strong>: Number of route tables associated with a VPC</li><li id="vpc_quota_0001__li11377435103319"><strong id="vpc_quota_0001__b12681238195715">routetableContainRoutes</strong>: Number of routes in a route table</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section8545767"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_quota_0001__p830316592176">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section13646533611"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_quota_0001__screen516413019309">GET https://{Endpoint}/v1/{project_id}/quotas</pre>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section9803039"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_quota_0001__table66351430155536" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_quota_0001__row25019730155536"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_quota_0001__p13332267155536">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_quota_0001__p30154725155536">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_quota_0001__p26613655155536">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_quota_0001__row8222433155536"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_quota_0001__p62037356155536">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_quota_0001__p11836771155536"><a href="#vpc_quota_0001__table11308015155544">quotas</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_quota_0001__p39072163155536">Specifies the quota object. For details, see <a href="#vpc_quota_0001__table11308015155544">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_quota_0001__table11308015155544"></a><a name="table11308015155544"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_quota_0001__table11308015155544" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_quota_0001__b33165484217">quotas</strong> field</caption><thead align="left"><tr id="vpc_quota_0001__row37694756155544"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_quota_0001__p33376361155544">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_quota_0001__p6082737155544">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_quota_0001__p22939651155544">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_quota_0001__row46172458155544"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_quota_0001__p48981646155544">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_quota_0001__p51341867155544">Array of <a href="#vpc_quota_0001__table8208684">resource</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_quota_0001__p48584024155544">Specifies the resource objects. For details, see <a href="#vpc_quota_0001__table8208684">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_quota_0001__table8208684"></a><a name="table8208684"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_quota_0001__table8208684" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="vpc_quota_0001__b1815662817312">resource</strong> field</caption><thead align="left"><tr id="vpc_quota_0001__row19762867"><th align="left" class="cellrowborder" valign="top" width="15.959999999999999%" id="mcps1.3.5.4.2.4.1.1"><p id="vpc_quota_0001__p57288388">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.1%" id="mcps1.3.5.4.2.4.1.2"><p id="vpc_quota_0001__p3523125172732">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.5.4.2.4.1.3"><p id="vpc_quota_0001__p59475690">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_quota_0001__row52801617"><td class="cellrowborder" valign="top" width="15.959999999999999%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_quota_0001__p49072547">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.1%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_quota_0001__p16937702172732">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_quota_0001__ul15534105019216"><li id="vpc_quota_0001__vpc_quota_0001_li1767724712142">Specifies the resource type.</li><li id="vpc_quota_0001__vpc_quota_0001_li7625114921413">Values:<ul id="vpc_quota_0001__vpc_quota_0001_ul9961151312919"><li id="vpc_quota_0001__vpc_quota_0001_li99111844123411"><strong id="vpc_quota_0001__vpc_quota_0001_b14549171332919">vpc</strong>: VPC</li><li id="vpc_quota_0001__vpc_quota_0001_li2961113172920"><strong id="vpc_quota_0001__vpc_quota_0001_b18886233182919">subnet</strong>: Subnet</li><li id="vpc_quota_0001__vpc_quota_0001_li3961141342914"><strong id="vpc_quota_0001__vpc_quota_0001_b74529492296">securityGroup</strong>: Security group</li><li id="vpc_quota_0001__vpc_quota_0001_li396171322915"><strong id="vpc_quota_0001__vpc_quota_0001_b17924155813295">securityGroupRule</strong>: Security group rule</li><li id="vpc_quota_0001__vpc_quota_0001_li15961151313295"><strong id="vpc_quota_0001__vpc_quota_0001_b49801311133018">publicIp</strong>: <span id="vpc_quota_0001__vpc_quota_0001_text1857544105311"></span><span id="vpc_quota_0001__vpc_quota_0001_text5575154115319">EIP</span></li><li id="vpc_quota_0001__vpc_quota_0001_li14961181382917"><strong id="vpc_quota_0001__vpc_quota_0001_b12131417103019">vpn</strong>: VPN</li><li id="vpc_quota_0001__vpc_quota_0001_li15961713112912"><strong id="vpc_quota_0001__vpc_quota_0001_b373014367304">vpcPeer</strong>: VPC peering connection</li><li id="vpc_quota_0001__vpc_quota_0001_li196114133292"><strong id="vpc_quota_0001__vpc_quota_0001_b19659765313">loadbalancer</strong>: Load balancer</li><li id="vpc_quota_0001__vpc_quota_0001_li1996171318294"><strong id="vpc_quota_0001__vpc_quota_0001_b19332143620498">listener</strong>: Load balancer listener</li><li id="vpc_quota_0001__vpc_quota_0001_li89611613172916"><strong id="vpc_quota_0001__vpc_quota_0001_b959714433515">physicalConnect</strong>: Direct Connect connection</li><li id="vpc_quota_0001__vpc_quota_0001_li7961151312910"><strong id="vpc_quota_0001__vpc_quota_0001_b19988164645318">virtualInterface</strong>: Virtual interface</li><li id="vpc_quota_0001__vpc_quota_0001_li1696111382920"><strong id="vpc_quota_0001__vpc_quota_0001_b16211487533">firewall</strong>: Firewall</li><li id="vpc_quota_0001__vpc_quota_0001_li29617137299"><strong id="vpc_quota_0001__vpc_quota_0001_b11145638145419">shareBandwidthIP</strong>: IP address added to a shared bandwidth</li><li id="vpc_quota_0001__vpc_quota_0001_li49613134298"><strong id="vpc_quota_0001__vpc_quota_0001_b13994435545">shareBandwidth</strong>: Shared bandwidth</li><li id="vpc_quota_0001__vpc_quota_0001_li129611813122917"><strong id="vpc_quota_0001__vpc_quota_0001_b3284153319554">address_group</strong>: IP address group</li><li id="vpc_quota_0001__vpc_quota_0001_li7614113763211"><strong id="vpc_quota_0001__vpc_quota_0001_b1485105895518">flow_log</strong>: VPC fow log</li><li id="vpc_quota_0001__vpc_quota_0001_li10868104283219"><strong id="vpc_quota_0001__vpc_quota_0001_b580115451566">vpcContainRoutetable</strong>: Number of route tables associated with a VPC</li><li id="vpc_quota_0001__vpc_quota_0001_li11377435103319"><strong id="vpc_quota_0001__vpc_quota_0001_b12681238195715">routetableContainRoutes</strong>: Number of routes in a route table</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_quota_0001__row49017803"><td class="cellrowborder" valign="top" width="15.959999999999999%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_quota_0001__p11019092">used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.1%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_quota_0001__p29776587172732">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_quota_0001__ul255215419218"><li id="vpc_quota_0001__li125528548212">Specifies the number of created network resources.</li><li id="vpc_quota_0001__li85525540213">The value ranges from <strong id="vpc_quota_0001__b1407708997192551">0</strong> to the value of <strong id="vpc_quota_0001__b637466560192551">quota</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_quota_0001__row13742502"><td class="cellrowborder" valign="top" width="15.959999999999999%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_quota_0001__p39400845">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.1%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_quota_0001__p63093324172732">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="vpc_quota_0001__ul399282316224"><li id="vpc_quota_0001__li139921923122213">Specifies the maximum quota values for the resources.</li><li id="vpc_quota_0001__li5992162318221">The value ranges from the default quota value to the maximum quota value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_quota_0001__row4925573392829"><td class="cellrowborder" valign="top" width="15.959999999999999%" headers="mcps1.3.5.4.2.4.1.1 "><p id="vpc_quota_0001__p576726292829">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.1%" headers="mcps1.3.5.4.2.4.1.2 "><p id="vpc_quota_0001__p3758450892829">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.5.4.2.4.1.3 "><p id="vpc_quota_0001__p6018282892829">Specifies the minimum quota value allowed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="vpc_quota_0001__note795511430441"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="vpc_quota_0001__p1795519432440">If value <strong id="vpc_quota_0001__b118911831819">-1</strong> is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section375512243718"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_quota_0001__screen49022339286">{
|
|
"quotas": {
|
|
"resources": [
|
|
{
|
|
"type": "vpc",
|
|
"used": 4,
|
|
"quota": 150,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "subnet",
|
|
"used": 5,
|
|
"quota": 400,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "securityGroup",
|
|
"used": 1,
|
|
"quota": 100,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "securityGroupRule",
|
|
"used": 6,
|
|
"quota": 5000,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "publicIp",
|
|
"used": 2,
|
|
"quota": 10,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "vpn",
|
|
"used": 0,
|
|
"quota": 5,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "vpcPeer",
|
|
"used": 0,
|
|
"quota": 50,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "firewall",
|
|
"used": 0,
|
|
"quota": 200,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "shareBandwidth",
|
|
"used": 0,
|
|
"quota": 5,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "shareBandwidthIP",
|
|
"used": 0,
|
|
"quota": 20,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "loadbalancer",
|
|
"used": 0,
|
|
"quota": 10,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "listener",
|
|
"used": 0,
|
|
"quota": 10,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "vpcContainRoutetable",
|
|
"used": 0,
|
|
"quota": 1,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "routetableContainRoutes",
|
|
"used": 0,
|
|
"quota": 200,
|
|
"min": 0
|
|
},
|
|
{
|
|
"type": "address_group",
|
|
"used": 0,
|
|
"quota": 50,
|
|
"min": 0
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section35741358184313"><h4 class="sectiontitle">Status Code</h4><p id="vpc_quota_0001__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_quota_0001__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_quota_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_quota_0000.html">Quota</a></div>
|
|
</div>
|
|
</div>
|
|
|