cinder/api-ref/source/v3/limits.inc
whoami-rajat 66638a0e78 Automate generation of qos specs api-ref samples
This patch adds the following tests:
1) limits
2) qos specifications

Change-Id: I1c4c7ea0f08469395bea1091c8f71ccc3b62c01d
Partially-Implements: blueprint generating-sample-files
2019-09-27 17:43:40 +05:30

64 lines
1.3 KiB
ReStructuredText

.. -*- rst -*-
Limits (limits)
===============
Shows absolute limits for a project.
An absolute limit value of ``-1`` indicates that the absolute limit
for the item is infinite.
Show absolute limits for project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/limits
Shows absolute limits for a project.
An absolute limit value of ``-1`` indicates that the absolute limit
for the item is infinite.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 200
.. rest_status_code:: error ../status.yaml
- 403
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- limits: limits
- rate: rate
- absolute: absolute
- totalSnapshotsUsed: totalSnapshotsUsed_int
- maxTotalBackups: maxTotalBackups
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
- maxTotalSnapshots: maxTotalSnapshots
- maxTotalBackupGigabytes: maxTotalBackupGigabytes
- totalBackupGigabytesUsed: totalBackupGigabytesUsed
- maxTotalVolumes: maxTotalVolumes
- totalVolumesUsed: totalVolumesUsed
- totalBackupsUsed: totalBackupsUsed
- totalGigabytesUsed: totalGigabytesUsed
Response Example
----------------
.. literalinclude:: ./samples/limits/limits-show-response.json
:language: javascript