117f614428
We had a mix of formatting for our API response codes. This makes it so all have a leading space, no trailing comma, and no empty Error response labels. This also addresses a formatting issue with due to the spacing between the Normal and Error lines that was causing the two to run together in the formatted HTML, making it harder to read. Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
58 lines
1.2 KiB
ReStructuredText
58 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Limits (limits)
|
|
===============
|
|
|
|
Shows absolute limits for a tenant.
|
|
|
|
An absolute limit value of ``-1`` indicates that the absolute limit
|
|
for the item is infinite.
|
|
|
|
|
|
Show absolute limits
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/limits
|
|
|
|
Shows absolute limits for a tenant.
|
|
|
|
An absolute limit value of ``-1`` indicates that the absolute limit
|
|
for the item is infinite.
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 203
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
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
|