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 octl

The GetProjectQuotas command gets the quota details for a specific project.

Request sample
$ octl kube api GetProjectQuotas <project_id> --profile "default"

The GetProjectQuotas command returns the following elements:

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the API request.

  • Project: The quota details associated with the project.

    • request_id: The ID of the API request.

    • data: The quota information related to the request.

      • quotas: A list of quota details.

        • ShortDescription: A brief summary of the quota.

        • QuotaCollection: A category or group to which the quota belongs to.

        • AccountId: The ID of the account.

        • Description: A detailed description of the quota.

        • MaxValue: The maximum allowed value for the quota.

        • UsedValue: The current usage value for the quota.

        • Name: The name of the quota.

      • subregions: A list of Subregion details.

        • State: The state of the Subregion.

        • RegionName: The name of the Region containing the Subregion.

        • SubregionName: The name of the Subregion.

        • LocationCode: The location code (physical zone) of the Subregion.

Result sample
{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Project": {
    "request_id": "string",
    "data": {
      "quotas": [
        {
          "ShortDescription": "string",
          "QuotaCollection": "string",
          "AccountId": "string",
          "Description": "string",
          "MaxValue": 0,
          "UsedValue": 0,
          "Name": "string"
        }
      ],
      "subregions": [
        {
          "State": "string",
          "RegionName": "string",
          "SubregionName": "string",
          "LocationCode": "string"
        }
      ]
    }
  }
}

Getting Information About the Quotas of a Project Using 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 \
    --output json

This command contains the following options 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 | table). 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 OUTSCALE 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