Help Center/ Elastic Volume Service/ API Reference/ OpenStack Cinder API v2/ EVS Disk/ Querying Details of Tenant Quotas

Updated on 2022-11-02 GMT+08:00

View PDF

Querying Details of Tenant Quotas

URI

URI format
GET /v2/{project_id}/os-quota-sets/{target_project_id}?usage=True

Parameter description

Parameter	Mandatory	Description
project_id	Yes	The project ID. For details about how to obtain the project ID, see Obtaining a 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.

Parameter

Mandatory

Description

project_id

Yes

The project ID.

For details about how to obtain the project ID, see Obtaining a 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}/v2/{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_GPSSD	Object	The number of reserved 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. See Parameters in the QuotaDetailVolumesGPSSD 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.
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_GPSSD	Object	The number of snapshots reserved 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. See Parameters in the QuotaDetailSnapshotsGPSSD 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.
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_GPSSD	Object	The size (GB) reserved 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. See Parameters in the QuotaDetailGigabytesGPSSD 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.
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.

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 QuotaDetailSnapshotsSATA 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 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 QuotaDetailGigabytesGPSSD field

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

Parameters in the QuotaDetailSnapshotsGPSSD field

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

Parameters in the QuotaDetailVolumesGPSSD 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.

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
        }

    }
}

{
    "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.

Parent topic: EVS Disk

Previous topic: Querying Details About an EVS Disk Type

Next topic: Adding the Metadata for an EVS Disk

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.

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