acf8c99e9b
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: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
88 lines
2.0 KiB
ReStructuredText
88 lines
2.0 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
======
|
|
Limits
|
|
======
|
|
|
|
Limits are the resource limitations that are allowed for each
|
|
tenant (project). An administrator can configure limits in the
|
|
``manila.conf`` file.
|
|
|
|
Users can query their rate and absolute limits. The absolute limits
|
|
contain information about:
|
|
|
|
- Total maximum share memory, in GBs.
|
|
|
|
- Number of share-networks.
|
|
|
|
- Number of share-snapshots.
|
|
|
|
- Number of shares.
|
|
|
|
- Shares and total used memory, in GBs.
|
|
|
|
- Snapshots and total used memory, in GBs.
|
|
|
|
Rate limits control the frequency at which users can issue specific
|
|
API requests. Administrators use rate limiting to configure limits
|
|
on the type and number of API calls that can be made in a specific
|
|
time interval. For example, a rate limit can control the number of
|
|
GET requests that can be processed during a one-minute period.
|
|
|
|
|
|
List share limits
|
|
=================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/limits
|
|
|
|
Lists share limits.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id_path
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- maxTotalShareGigabytes: maxTotalShareGigabytes
|
|
- maxTotalSnapshotGigabytes: maxTotalSnapshotGigabytes
|
|
- maxTotalShares: maxTotalShares
|
|
- maxTotalShareSnapshots: maxTotalShareSnapshots
|
|
- maxTotalShareNetworks: maxTotalShareNetworks
|
|
- totalSharesUsed: totalSharesUsed
|
|
- totalShareSnapshotsUsed: totalShareSnapshotsUsed
|
|
- totalShareNetworksUsed: totalShareNetworksUsed
|
|
- totalShareGigabytesUsed: totalShareGigabytesUsed
|
|
- totalSnapshotGigabytesUsed: totalSnapshotGigabytesUsed
|
|
- uri: uri
|
|
- regex: regex
|
|
- value: value
|
|
- verb: verb
|
|
- remaining: remaining
|
|
- unit: unit
|
|
- next-available: next-available
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/limits-response.json
|
|
:language: javascript
|