Querying Details of Tenant Quotas

Function

This API is used to query the details of tenant quotas.

URI

• URI format

  GET /v3/{project_id}/os-quota-sets/{target_project_id}?usage=True

• Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	The project ID.
  target_project_id	Yes	The ID of the target project. Set this parameter to the value of project_id.
  usage	Yes	Whether to query quota details. Only value true is supported currently.

Request

• Example request

  GET https://{endpoint}/v3/{project_id}/os-quota-sets/{project_id}?usage=True
  

Response

• Response parameters

  Parameter	Type	Description
  quota_set	Object	The returned quota information. For details, see Parameters in the quota_set field.
  error	Object	The error message returned if an error occurs. For details, see Parameters in the error field.

• Parameters in the quota_set field

  Parameter	Type	Description
  volumes	Object	The number of disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailVolumes field.
  snapshots	Object	The number of snapshots. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailSnapshots field.
  gigabytes	Object	The total size (GB) of disks and snapshots allowed. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailGigabytes field.
  volumes_SSD	Object	The number of reserved ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailVolumesSSD field.
  volumes_SAS	Object	The number of reserved high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailVolumesSAS field.
  volumes_SATA	Object	The number of reserved common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailVolumesSATA field.
  volumes_ESSD	Object	The number of reserved extreme SSD disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailVolumesESSD field.
  snapshots_SSD	Object	The number of snapshots reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailSnapshotsSSD field.
  snapshots_SAS	Object	The number of snapshots reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailSnapshotsSAS field.
  snapshots_SATA	Object	The number of snapshots reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailSnapshotsSATA field.
  snapshots_ESSD	Object	The number of snapshots reserved for extreme SSD disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailSnapshotsESSD field.
  gigabytes_SSD	Object	The size (GB) reserved for ultra-high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailGigabytesSSD field.
  gigabytes_SAS	Object	The size (GB) reserved for high I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailGigabytesSAS field.
  gigabytes_SATA	Object	The size (GB) reserved for common I/O disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailGigabytesSATA field.
  gigabytes_ESSD	Object	The size (GB) reserved for extreme SSD disks. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailGigabytesESSD field.
  id	String	The tenant ID. The tenant ID is the same as the project ID.
  backups	Object	The number of backups. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailBackups field.
  backup_gigabytes	Object	The backup size (GB). Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailBackupGigabytes field.
  per_volume_gigabytes	Object	The capacity quota of each disk. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs. See Parameters in the QuotaDetailPerVolumeGigabytes field.

  Note

  If the limit value returned in the response is -1, no quota limit has been set.

• Parameters in the QuotaDetailBackupGigabytes field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailBackups field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailGigabytes field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailSnapshots field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailVolumes field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailGigabytesSATA field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailGigabytesESSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailSnapshotsSATA field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailSnapshotsESSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailVolumesSATA field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailVolumesESSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailGigabytesSAS field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailSnapshotsSAS field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailVolumesSAS field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailGigabytesSSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailSnapshotsSSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailVolumesSSD field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the QuotaDetailPerVolumeGigabytes field

  Parameter	Type	Description
  in_use	Integer	The used quota.
  limit	Integer	The maximum quota.
  reserved	Integer	The reserved field.

• Parameters in the error field

  Parameter	Type	Description
  message	String	The error message returned if an error occurs.
  code	String	The error code returned if an error occurs. For details about the error code, see Error Codes.

• Example response

  {
      "quota_set": {
          "gigabytes_SAS": {
              "reserved": 0,
              "limit": -1,
              "in_use": 21
          },
          "gigabytes": {
              "reserved": 0,
              "limit": 42790,
              "in_use": 2792
          },
          "backup_gigabytes": {
              "reserved": 0,
              "limit": 5120,
              "in_use": 51
          },
          "snapshots_SAS": {
              "reserved": 0,
              "limit": -1,
              "in_use": 0
          },
          "volumes_SSD": {
              "reserved": 0,
              "limit": -1,
              "in_use": 28
          },
          "snapshots": {
              "reserved": 0,
              "limit": 10,
              "in_use": 6
          },
          "id": "cd631140887d4b6e9c786b67a6dd4c02",
          "volumes_SAS": {
              "reserved": 0,
              "limit": -1,
              "in_use": 2
          },
          "snapshots_SSD": {
              "reserved": 0,
              "limit": -1,
              "in_use": 0
          },
          "volumes": {
              "reserved": 0,
              "limit": -1,
              "in_use": 108
          },
          "backups": {
              "reserved": 0,
              "limit": 100,
              "in_use": 10
          },
          "gigabytes_SSD": {
              "reserved": 0,
              "limit": -1,
              "in_use": 1085
          }
  
      }
  }
  

  or

  {
      "error": {
          "message": "XXXX",
          "code": "XXX"
      }
  }
  

  In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:

  {
      "badrequest": {
          "message": "XXXX",
          "code": "XXX"
      }
  }
  

Status Codes

• Normal

  200

Error Codes

For details, see Error Codes.

last updated: 2024-11-13 14:31 UTC - commit: 8d943812e7d8424718eb8315e2294eccf373143f