Getting Information About the Quotas of a Project

You can get information about the quotas of a project using OKS CLI.

Getting Information About the Quotas of a Project Using OKS CLI

Before you begin: Install and configure OKS CLI. For more information, see Installing and Configuring OKS CLI.

The project quotas command allows you to retrieve the quotas and Region mapping for a project:

Request sample
$ oks-cli project quotas \
    --project-name NAME_OF_PROJECT

This command contains the following attribute that you need to specify:

  • project-name: The name of the project you want to retrieve quota information from.

  • (optional) output: The output format for the response (json| yaml). By default, the response format is JSON.

The project quotas command returns the following elements:

  • quotas: A list of IaaS quota entries, each including:

    • ShortDescription: A description of the quota.

    • QuotaCollection: The category of resource type that the quota applies to.

    • AccountId: The unique identifier of the Cloud account where the project’s infrastructure (such as the VPC and node pools) is deployed. You can use this ID when requesting IaaS quota changes from the Support team.

    • Description: A more detailed description of the quota.

    • MaxValue: The maximum allowed usage for this resource.

    • UsedValue: The current usage of the resource within the quota.

    • Name: The identifier for the quota.

  • subregions: A list of available Subregions for the project, each including:

    • State: The availability status of the Subregion.

    • RegionName: The name of the Region where the Subregion is located.

    • SubregionName: The name of the Subregion.

    • LocationCode: The code of the physical zone where the Subregion is located.

For more information, see About Regions and Subregions.
Result sample
[
  {
    "quotas": [
      {
        "ShortDescription": "VM Limit",
        "QuotaCollection": "Compute",
        "AccountId": "123456789012",
        "Description": "Maximum number of VM this user can own",
        "MaxValue": 150,
        "UsedValue": 8,
        "Name": "vm_limit"
      }
    ],
    "subregions": [
      {
        "State": "available",
        "RegionName": "eu-west-2",
        "SubregionName": "eu-west-2a",
        "LocationCode": "PAR1"
      },
      {
        "State": "available",
        "RegionName": "eu-west-2",
        "SubregionName": "eu-west-2b",
        "LocationCode": "PAR4"
      },
      {
        "State": "available",
        "RegionName": "eu-west-2",
        "SubregionName": "eu-west-2c",
        "LocationCode": "PAR7"
      }
    ]
  }
]

Related Pages

Corresponding API Method

Export to PDF