api-ref
source
samples
availability-zones.inc
conf.py
experimental.inc
extensions.inc
index.rst
limits.inc
os-share-manage.inc
parameters.yaml
quota-classes.inc
quota-sets.inc
scheduler-stats.inc
security-services.inc
services.inc
share-actions.inc
share-export-locations.inc
share-group-snapshots.inc
share-group-types.inc
share-groups.inc
share-instance-export-locations.inc
share-instances.inc
share-metadata.inc
share-migration.inc
share-networks.inc
share-replicas.inc
share-servers.inc
share-types.inc
shares.inc
snapshot-instances.inc
snapshots.inc
user-messages.inc
versions.inc
contrib
devstack
doc
etc
manila
playbooks
rally-jobs
releasenotes
tools
.coveragerc
.gitignore
.gitreview
.stestr.conf
.zuul.yaml
CONTRIBUTING.rst
HACKING.rst
LICENSE
README.rst
babel.cfg
requirements.txt
run_tests.sh
setup.cfg
setup.py
test-requirements.txt
tox.ini

This patch refactors limits and services API to make it clear to understand and maintain. Change-Id: I0e214f59e193f861e4959dfef951854bea530b7b
78 lines
1.9 KiB
ReStructuredText
78 lines
1.9 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.
|
|
|
|
Normal response codes: 200
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(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
|