Querying Quotas

Function

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.

URI

GET /v1/{project_id}/quotas

Example:

GET https://{Endpoint}/v1/{project_id}/quotas?type={type}

Table 1 <vpc_quota_0001__table38014313> describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
type	No	String	Specifies the resource type. Values: vpc subnet securityGroup securityGroupRule publicIp vpn vpngw vpcPeer loadbalancer listener physicalConnect virtualInterface firewall shareBandwidthIP shareBandwidth address_group flow_log vpcContainRoutetable routetableContainRoutes

Request Message

Request parameter
```
None
```

Example request

GET https://{Endpoint}/v1/{project_id}/quotas

Response Message

Response parameter

**Table 2** Response parameter
Name	Type	Description
quotas	`quotas <vpc_quota_0001__table11308015155544>` object	Specifies the quota object. For details, see `Table 3 <vpc_quota_0001__table11308015155544>`.

**Table 3** Description of the **quotas** field
Name	Type	Description
resources	Array of `resource <vpc_quota_0001__table8208684>` objects	Specifies the resource objects. For details, see `Table 4 <vpc_quota_0001__table8208684>`.

**Table 4** Description of the **resource** field
Name	Type	Description
type	String	Specifies the resource type. Values: vpc subnet securityGroup securityGroupRule publicIp vpn vpngw vpcPeer loadbalancer listener physicalConnect virtualInterface firewall shareBandwidthIP shareBandwidth address_group flow_log vpcContainRoutetable routetableContainRoutes
used	Integer	Specifies the number of created network resources. The value ranges from 0 to the value of quota.
quota	Integer	Specifies the maximum quota values for the resources. The value ranges from the default quota value to the maximum quota value. The default quota values can be changed. Configure the quota values in the underlying system in advance. Default quota values: VPC: 150 Subnet: 400 Security group: 100 Security group rule: 5000 EIPs: 10 VPNs: 5 VPC peering connections: 50 Load balancers: 10 Listeners: 10 Firewalls: 200 EIPs that can be added to a shared bandwidth: 20 Shared bandwidths: 5 IP address groups: 50 Route table per VPC: 1 Routes per route table: 200
min	Integer	Specifies the minimum quota value allowed.

Example response

{
    "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
            }
        ]
    }
}

Status Code

See Status Codes <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.

17 KiB Raw Blame History