3e86e3deac
The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
174 lines
3.6 KiB
ReStructuredText
174 lines
3.6 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========
|
|
Quota sets
|
|
==========
|
|
|
|
Provides quotas management support.
|
|
|
|
.. important::
|
|
|
|
For API versions 2.6 and prior, replace ``quota-sets`` in the URLs with
|
|
``os-quota-sets``.
|
|
|
|
|
|
Show default quotas
|
|
===================
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}/defaults
|
|
|
|
Shows default quotas for a tenant.
|
|
|
|
Normal response codes: 200
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id_1
|
|
- tenant_id: tenant_id
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_set: quota_set
|
|
- id: id_15
|
|
- gigabytes: gigabytes
|
|
- snapshots: snapshots
|
|
- shares: shares
|
|
- snapshot_gigabytes: snapshot_gigabytes
|
|
- share_networks: share_networks
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/quota-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show quotas
|
|
===========
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
|
|
|
|
Shows quotas for a tenant.
|
|
|
|
If you specify the optional ``user_id`` query parameter, you get
|
|
the quotas for this user in the tenant. If you omit this parameter,
|
|
you get the quotas for the project.
|
|
|
|
Normal response codes: 200
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id_1
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id_1
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_set: quota_set
|
|
- id: id_15
|
|
- gigabytes: gigabytes
|
|
- snapshots: snapshots
|
|
- shares: shares
|
|
- snapshot_gigabytes: snapshot_gigabytes
|
|
- share_networks: share_networks
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/quota-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update quotas
|
|
=============
|
|
|
|
.. rest_method:: PUT /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
|
|
|
|
Updates quotas for a tenant.
|
|
|
|
If you specify the optional ``user_id`` query parameter, you update
|
|
the quotas for this user in the tenant. If you omit this parameter,
|
|
you update the quotas for the project.
|
|
|
|
Normal response codes: 200
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id_1
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id_1
|
|
- quota_set: quota_set
|
|
- force: force
|
|
- gigabytes: gigabytes_1
|
|
- snapshots: snapshots_1
|
|
- snapshot_gigabytes: snapshot_gigabytes_1
|
|
- shares: shares_1
|
|
- share_networks: share_networks_1
|
|
|
|
Request example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/quota-update-request.json
|
|
:language: javascript
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- quota_set: quota_set
|
|
- id: id_15
|
|
- gigabytes: gigabytes
|
|
- snapshots: snapshots
|
|
- shares: shares
|
|
- snapshot_gigabytes: snapshot_gigabytes
|
|
- share_networks: share_networks
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/quota-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete quotas
|
|
=============
|
|
|
|
.. rest_method:: DELETE /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
|
|
|
|
Deletes quotas for a tenant. The quota reverts to the default quota.
|
|
|
|
If you specify the optional ``user_id`` query parameter, you delete
|
|
the quotas for this user in the tenant. If you omit this parameter,
|
|
you delete the quotas for the project.
|
|
|
|
Error response codes: 202
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id_1
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id_1
|