cinder/api-ref/source/v3/limits.inc
zhufl cd33e6d841 api-ref: totalSnapshotsUsed in limits response should be integer
https://developer.openstack.org/api-ref/block-storage/v3/index.html#show-absolute-limits-for-project

totalSnapshotsUsed in limits response should be integer, but
not string. And totalSnapshotsUsed is also used in hosts response
which is string, so this is to add a new parameter for totalSnapshotsUsed.

Change-Id: I48f61f50defe9782d5a7afb7d7fa245f562785a0
2018-10-11 17:18:13 +08:00

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_1
- maxTotalBackups: maxTotalBackups
- maxTotalVolumeGigabytes: maxTotalVolumeGigabytes
- maxTotalSnapshots: maxTotalSnapshots
- maxTotalBackupGigabytes: maxTotalBackupGigabytes
- totalBackupGigabytesUsed: totalBackupGigabytesUsed
- maxTotalVolumes: maxTotalVolumes
- totalVolumesUsed: totalVolumesUsed
- totalBackupsUsed: totalBackupsUsed
- totalGigabytesUsed: totalGigabytesUsed
Response Example
----------------
.. literalinclude:: ./samples/limits-show-response.json
:language: javascript