651 lines
12 KiB
ReStructuredText
651 lines
12 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==============
|
|
Unified Limits
|
|
==============
|
|
|
|
In OpenStack, a quota system mainly contains two parts: ``limit`` and
|
|
``usage``. The Unified limits in Keystone is a replacement of the ``limit``
|
|
part. It contains two kinds of resouces: ``Registered Limit`` and ``Limit``. A
|
|
``registered limit`` is a default limit. It is usually created by the services
|
|
which are registered in Keystone. A ``limit`` is the limit that override the
|
|
registered limit for each project.
|
|
|
|
List Registered Limits
|
|
======================
|
|
|
|
.. rest_method:: GET /v3/registered_limits
|
|
|
|
Lists Registered Limits.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limits``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- service_id: service_id_query
|
|
- region_id: region_id_query
|
|
- resource_name: resource_name_query
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- links: link_collection
|
|
- registered_limits: registered_limits
|
|
- id: registered_limit_id
|
|
- service_id: service_id_registered_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- default_limit: default_limit
|
|
- description: description_registered_limit_response_body
|
|
- links: link_response_body
|
|
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limits-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Create Registered Limits
|
|
========================
|
|
|
|
.. rest_method:: POST /v3/registered_limits
|
|
|
|
Creates registered limits. It supports to create more than one registered limit
|
|
in one request.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limits``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limits: registered_limits
|
|
- service_id: service_id_registered_limit
|
|
- region_id: region_id_request_body
|
|
- resource_name: resource_name
|
|
- default_limit: default_limit
|
|
- description: description_registered_limit_request_body
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limits-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limits: registered_limits
|
|
- id: registered_limit_id
|
|
- service_id: service_id_registered_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- default_limit: default_limit
|
|
- description: description_registered_limit_response_body
|
|
- links: link_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 201
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 409
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limits-create-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update Registered Limits
|
|
========================
|
|
|
|
.. rest_method:: PATCH /v3/registered_limits/{registered_limit_id}
|
|
|
|
Updates the specified registered limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limit_id: registered_limit_id_path
|
|
- registered_limit: registered_limit
|
|
- service_id: request_service_id_registered_limit_body_not_required
|
|
- region_id: request_region_id_registered_limit_body_not_required
|
|
- resource_name: request_resource_name_body_not_required
|
|
- default_limit: request_default_limit_body_not_required
|
|
- description: description_registered_limit_request_body
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limits-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limit: registered_limit
|
|
- id: registered_limit_id
|
|
- service_id: service_id_registered_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- default_limit: default_limit
|
|
- description: description_registered_limit_response_body
|
|
- links: link_response_body
|
|
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 409
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limits-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show Registered Limit Details
|
|
=============================
|
|
|
|
.. rest_method:: GET /v3/registered_limits/{registered_limit_id}
|
|
|
|
Shows details for a registered limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limit_id: registered_limit_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limit: registered_limit
|
|
- id: registered_limit_id
|
|
- service_id: service_id_registered_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- default_limit: default_limit
|
|
- description: description_registered_limit_response_body
|
|
- links: link_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/registered-limit-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete Registered Limit
|
|
=======================
|
|
|
|
.. rest_method:: DELETE /v3/registered_limits/{registered_limit_id}
|
|
|
|
Deletes a registered limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- registered_limit_id: registered_limit_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
|
|
Get Enforcement Model
|
|
=====================
|
|
|
|
.. rest_method:: GET /v3/limits/model
|
|
|
|
Return the configured limit enforcement model.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit_model``
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- model: limit_model_required_response_body
|
|
- name: limit_model_name_required_response_body
|
|
- description: limit_model_description_required_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
|
|
Flat Enforcement Example
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/limit-flat-model-response.json
|
|
:language: javascript
|
|
|
|
|
|
List Limits
|
|
===========
|
|
|
|
.. rest_method:: GET /v3/limits
|
|
|
|
Lists Limits.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limits``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- service_id: service_id_query
|
|
- region_id: region_id_query
|
|
- resource_name: resource_name_query
|
|
- project_id: scope_project_id_query
|
|
- domain_id: scope_domain_id_query
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- links: link_collection
|
|
- limits: limits
|
|
- id: limit_id
|
|
- project_id: project_id
|
|
- domain_id: response_limit_domain_id_body
|
|
- service_id: service_id_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- resource_limit: resource_limit
|
|
- description: description_limit_response_body
|
|
- links: link_response_body
|
|
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/limits-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Create Limits
|
|
=============
|
|
|
|
.. rest_method:: POST /v3/limits
|
|
|
|
Creates limits. It supports to create more than one limit in one request.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limits``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limits: limits
|
|
- project_id: request_limit_project_id_not_required
|
|
- domain_id: request_limit_domain_id_not_required
|
|
- service_id: service_id_limit
|
|
- region_id: region_id_request_body
|
|
- resource_name: resource_name
|
|
- resource_limit: resource_limit
|
|
- description: description_limit_request_body
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
|
|
.. literalinclude:: ./samples/admin/limits-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limits: limits
|
|
- id: limit_id
|
|
- project_id: project_id
|
|
- domain_id: response_limit_domain_id_body
|
|
- service_id: service_id_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- resource_limit: resource_limit
|
|
- description: description_limit_response_body
|
|
- links: link_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 201
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 409
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
|
|
.. literalinclude:: ./samples/admin/limits-create-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update Limits
|
|
=============
|
|
|
|
.. rest_method:: PATCH /v3/limits/{limit_id}
|
|
|
|
Updates the specified limit. It only supports to update ``resource_limit`` or
|
|
``description`` for the limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit_id: limit_id_path
|
|
- limit: limit
|
|
- resource_limit: request_resource_limit_body_not_required
|
|
- description: description_limit_request_body
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/limits-update-request.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit: limit
|
|
- id: limit_id
|
|
- project_id: project_id
|
|
- domain_id: response_limit_domain_id_body
|
|
- service_id: service_id_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- resource_limit: resource_limit
|
|
- description: description_limit_response_body
|
|
- links: link_response_body
|
|
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 404
|
|
- 409
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/limits-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show Limit Details
|
|
==================
|
|
|
|
.. rest_method:: GET /v3/limits/{limit_id}
|
|
|
|
Shows details for a limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit_id: limit_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit: limit
|
|
- id: limit_id
|
|
- project_id: project_id
|
|
- domain_id: response_limit_domain_id_body
|
|
- service_id: service_id_limit
|
|
- region_id: region_id_response_body
|
|
- resource_name: resource_name
|
|
- resource_limit: resource_limit
|
|
- description: description_limit_response_body
|
|
- links: link_response_body
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
- 404
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. literalinclude:: ./samples/admin/limit-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete Registered Limit
|
|
=======================
|
|
|
|
.. rest_method:: DELETE /v3/limits/{limit_id}
|
|
|
|
Deletes a limit.
|
|
|
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
|
|
|
|
Request
|
|
-------
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit_id: limit_id_path
|
|
|
|
Response
|
|
--------
|
|
|
|
Status Codes
|
|
~~~~~~~~~~~~
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 401
|
|
- 403
|
|
- 404
|