Updated on 2022-01-25 GMT+08:00

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 describes the parameters.
Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

type

No

String

Specifies the resource type.

The value can be vpc, subnet, securityGroup, securityGroupRule, publicIp, vpn, vpngw, vpcPeer, firewall, shareBandwidth, shareBandwidthIP, loadbalancer, or listener.

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

    Object

    Specifies the quota object. For details, see Table 3.

    Table 3 Description of the quotas field

    Name

    Type

    Description

    resources

    Array of resource objects

    Specifies the resource objects. For details, see Table 4.

    Table 4 Description of the resource field

    Name

    Type

    Description

    type

    String

    • Specifies the resource type.
    • The value can be vpc, subnet, securityGroup, securityGroupRule, publicIp, vpn, vpngw, vpcPeer, firewall, shareBandwidth, or shareBandwidthIP.

    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 resource quota values can be changed. You must configure the quota values in the underlying system in advance. The default quota values of network resources are as follows:

      VPC: 5

      Subnet: 100

      Security group: 100

      Security group rule: 5000

      EIP: 10

      VPN: 5

      VPN gateway: 2

      VPC peering connection: 50

      Firewall: 200

      Shared bandwidth: 5

      IP address with shared bandwidth: 20

    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": "vpngw",
                    "used": 0,
                    "quota": 2,
                    "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.

Error Code

See Error Codes.