ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
439 lines
8.2 KiB
ReStructuredText
439 lines
8.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
====================================
|
|
Quota sets extension (os-quota-sets)
|
|
====================================
|
|
|
|
Administrators only, depending on policy settings.
|
|
|
|
Shows, updates, and deletes quotas for a tenant.
|
|
|
|
|
|
Show quota details for user
|
|
===========================
|
|
|
|
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id}
|
|
|
|
Shows details for quotas for a tenant and user.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- limit: limit
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-user-quotas/user-quotas-show-detail-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show default quotas
|
|
===================
|
|
|
|
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/defaults
|
|
|
|
Shows default quotas for a tenant.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-quota-sets/quotas-defaults-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show quotas
|
|
===========
|
|
|
|
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}
|
|
|
|
Shows quotas for a tenant.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- usage: usage
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-quota-sets/quotas-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Update quotas
|
|
=============
|
|
|
|
.. rest_method:: PUT /v1/{tenant_id}/os-quota-sets/{tenant_id}
|
|
|
|
Updates quotas for a tenant.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- id: id
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- security_groups: security_groups
|
|
- tenant_id: tenant_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/os-quota-sets/quotas-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-quota-sets/quotas-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Delete quotas
|
|
=============
|
|
|
|
.. rest_method:: DELETE /v1/{tenant_id}/os-quota-sets/{tenant_id}
|
|
|
|
Deletes quotas for a tenant so the quotas revert to default values.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude::
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Show quotas for user
|
|
====================
|
|
|
|
.. rest_method:: GET /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}
|
|
|
|
Enables an admin user to show quotas for a tenant and user.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-user-quotas/user-quotas-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Update quotas for user
|
|
======================
|
|
|
|
.. rest_method:: POST /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}
|
|
|
|
Updates quotas for a tenant and user.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- id: id
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- security_groups: security_groups
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: ../samples/os-user-quotas/user-quotas-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- injected_file_content_bytes: injected_file_content_bytes
|
|
- metadata_items: metadata_items
|
|
- reserved: reserved
|
|
- in_use: in_use
|
|
- ram: ram
|
|
- floating_ips: floating_ips
|
|
- key_pairs: key_pairs
|
|
- injected_file_path_bytes: injected_file_path_bytes
|
|
- instances: instances
|
|
- security_group_rules: security_group_rules
|
|
- injected_files: injected_files
|
|
- quota_set: quota_set
|
|
- cores: cores
|
|
- fixed_ips: fixed_ips
|
|
- id: id
|
|
- security_groups: security_groups
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/os-user-quotas/user-quotas-update-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
Delete quotas for user
|
|
======================
|
|
|
|
.. rest_method:: DELETE /v1/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}
|
|
|
|
Deletes quotas for a user so that the quotas revert to default values.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- user_id: user_id
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude::
|
|
:language: javascript
|
|
|
|
|
|
|