Help Center/ Elastic Volume Service/ API Reference/ Out-of-Date APIs/ Cinder API/ Quota Management/ Querying Detailed Quotas of a Tenant

Updated on 2024-02-27 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Detailed Quotas of a Tenant

Function

This API is used to query the detailed quotas of a tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/os-quota-sets/{target_project_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID.
target_project_id	Yes	String	The target project ID. Set this parameter to the value of project_id.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
usage	Yes	String	Whether to query quota details. Only value True is supported currently. Enumeration values: True

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
quota_set	QuotaList object	The returned quota information.

**Table 5** QuotaList
Parameter	Type	Description
backup_gigabytes	QuotaDetailBackupGigabytes object	The backup size, in GiB. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs.
backups	QuotaDetailBackups 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.
gigabytes	QuotaDetailGigabytes object	The total capacity, in GiB. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs.
id	String	The project ID.
snapshots	QuotaDetailSnapshots 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.
volumes	QuotaDetailVolumes 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.
gigabytes_SATA	QuotaDetailGigabytesSATA object	The capacity (GiB) 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.
snapshots_SATA	QuotaDetailSnapshotsSATA object	The number of snapshots 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.
volumes_SATA	QuotaDetailVolumesSATA object	The number of 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.
gigabytes_SAS	QuotaDetailGigabytesSAS object	The capacity (GiB) 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.
snapshots_SAS	QuotaDetailSnapshotsSAS object	The number of snapshots 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.
volumes_SAS	QuotaDetailVolumesSAS object	The number of 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.
gigabytes_SSD	QuotaDetailGigabytesSSD object	The capacity (GiB) 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.
snapshots_SSD	QuotaDetailSnapshotsSSD object	The number of snapshots 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.
volumes_SSD	QuotaDetailVolumesSSD object	The number of 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.
gigabytes_GPSSD	QuotaDetailGigabytesGPSSD object	The capacity (GiB) for general purpose 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.
snapshots_GPSSD	QuotaDetailSnapshotsGPSSD object	The number of snapshots for general purpose 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.
volumes_GPSSD	QuotaDetailVolumesGPSSD object	The number of general purpose 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.
per_volume_gigabytes	QuotaDetailPerVolumeGigabytes object	The capacity quota of a disk. Sub-parameters include reserved (reserved quota), limit (maximum quota), and in_use (used quota). They are all made up of key-value pairs.

**Table 6** QuotaDetailBackupGigabytes
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 7** QuotaDetailBackups
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 8** QuotaDetailGigabytes
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 9** QuotaDetailSnapshots
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 10** QuotaDetailVolumes
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 11** QuotaDetailGigabytesSATA
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 12** QuotaDetailSnapshotsSATA
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 13** QuotaDetailVolumesSATA
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 14** QuotaDetailGigabytesSAS
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 15** QuotaDetailSnapshotsSAS
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 16** QuotaDetailVolumesSAS
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 17** QuotaDetailGigabytesSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 18** QuotaDetailSnapshotsSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 19** QuotaDetailVolumesSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 20** QuotaDetailGigabytesGPSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 21** QuotaDetailSnapshotsGPSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 22** QuotaDetailVolumesGPSSD
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

**Table 23** QuotaDetailPerVolumeGigabytes
Parameter	Type	Description
in_use	Integer	The used quota.
limit	Integer	The maximum quota.
reserved	Integer	The reserved field.

Status code: 400

**Table 24** Response body parameters
Parameter	Type	Description
error	Error object	The error message returned if an error occurs.

**Table 25** Error
Parameter	Type	Description
code	String	The error code returned if an error occurs. For details about error codes and their meanings, see Error Codes.
message	String	The error message returned if an error occurs.

Example Requests

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

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

Example Responses

Status code: 200

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

Status code: 400

Bad Request

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

Status Codes

Status Code	Description
200	OK
400	Bad Request

Error Codes

See Error Codes.

Parent Topic: Quota Management

Previous topic: Quota Management

Next topic: Disk Metadata Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot