2e5a91da72
Rather than our freeform way of listing response codes in our api-ref, we should be using the os-api-ref extension option to get nicely formatted response code listings. https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code Change-Id: Iee21f54fe7cf0ea28258966e2d0f8fa2849c83f2
64 lines
1.3 KiB
ReStructuredText
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
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{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
|
|
|
|
- totalSnapshotsUsed: totalSnapshotsUsed
|
|
- maxTotalBackups: maxTotalBackups
|
|
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
|
|
- limits: limits
|
|
- maxTotalSnapshots: maxTotalSnapshots
|
|
- maxTotalBackupGigabytes: maxTotalBackupGigabytes
|
|
- totalBackupGigabytesUsed: totalBackupGigabytesUsed
|
|
- maxTotalVolumes: maxTotalVolumes
|
|
- totalVolumesUsed: totalVolumesUsed
|
|
- rate: rate
|
|
- totalBackupsUsed: totalBackupsUsed
|
|
- totalGigabytesUsed: totalGigabytesUsed
|
|
- absolute: absolute
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ./samples/limits-show-response.json
|
|
:language: javascript
|