List Quotas

client.quotas.list(?): QuotaList { items, pagination }

GET/v1/quotas

List quota usage and limits for the current organization across all regions

ReturnsExpand Collapse

QuotaList { items, pagination }

items: Array<Quota { compute, networking, nks, 2 more } >

compute: QuotaCompute { memory_gb, vcpu }

Compute quota.

memory_gb: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

vcpu: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

networking: QuotaNetworking { connect_connections, public_ips, vpcs }

Networking quota.

connect_connections: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

public_ips: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

vpcs: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

nks: QuotaNKS { clusters, node_pool_memory_gb, node_pool_vcpu, public_ips }

NKS quota.

clusters: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

node_pool_memory_gb: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

node_pool_vcpu: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

public_ips: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

region: RegionName { }

Region the resource is in.

storage: QuotaStorage { abs, local_nvme }

Storage quota.

abs: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

local_nvme: QuotaDimensionDetail { limit, remaining, used }

Quota dimension detail.

limit: number

remaining: number

used: number

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string | null

previous_cursor: string | null

total_count: number

minimum0

List Quotas

import NirvanaLabs from '@nirvana-labs/nirvana';

const client = new NirvanaLabs({
  apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});

const quotaList = await client.quotas.list();

console.log(quotaList.items);

{
  "items": [
    {
      "compute": {
        "memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "networking": {
        "connect_connections": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vpcs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "nks": {
        "clusters": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "region": "us-sva-2",
      "storage": {
        "abs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "local_nvme": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "compute": {
        "memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "networking": {
        "connect_connections": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "vpcs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "nks": {
        "clusters": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_memory_gb": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "node_pool_vcpu": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "public_ips": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      },
      "region": "us-sva-2",
      "storage": {
        "abs": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        },
        "local_nvme": {
          "limit": 32,
          "remaining": 24,
          "used": 8
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}