openstack/neutron-lib
Code Issues Proposed changes

Add info about API method to get default quotas

Browse Source 
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Part of blueprint neutron-in-tree-api-ref
Change-Id: I2090f024b101b6dea577d6d39500cfbd83111905
Partial-Bug: #1580642
This commit is contained in:
Sławek Kapłoński 2016-08-21 19:13:55 +00:00 committed by Akihiro Motoki
parent 705fd9090c
commit 35bcd60fcd
2 changed files with 149 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

183
api-ref/source/v2/parameters.yaml
View File

@ -169,11 +169,11 @@ tag:
in: path
required: false
type: string
tenant_id_33:
tenant_id-path:
description: |
The UUID of the tenant.
The ID of the tenant.
in: path
required: false
required: true
type: string
vip_id_1:
description: |
@ -1463,20 +1463,6 @@ floatingip:
in: body
required: true
type: object
floatingip_1:
description: |
The number of floating IP addresses allowed for
each tenant. A value of ``-1`` means no limit.
in: body
required: true
type: integer
floatingip_2:
description: |
The number of floating IP addresses allowed for
each tenant. A value of ``-1`` means no limit.
in: body
required: false
type: integer
floatingips:
description: |
A list of ``floatingip`` objects.
@ -2440,18 +2426,6 @@ network:
in: body
required: true
type: object
network_1:
description: |
The number of networks allowed for each tenant.
in: body
required: true
type: integer
network_2:
description: |
The number of networks allowed for each tenant.
in: body
required: false
type: integer
network_3:
description: |
A ``network`` object.
@ -2697,18 +2671,6 @@ port:
in: body
required: true
type: object
port_1:
description: |
The number of ports allowed for each tenant.
in: body
required: false
type: integer
port_2:
description: |
The number of ports allowed for each tenant.
in: body
required: true
type: integer
port_id_1:
description: |
The UUID of the port.
@ -2974,26 +2936,71 @@ quota:
in: body
required: true
type: object
quota-floatingip:
description: |
The number of floating IP addresses allowed for
each tenant. A value of ``-1`` means no limit.
in: body
required: true
type: integer
quota-network:
description: |
The number of networks allowed for each tenant.
in: body
required: true
type: integer
quota-port:
description: |
The number of ports allowed for each tenant.
in: body
required: true
type: integer
quota-rbac_policy:
description: |
The number of role-based access control (RBAC)
policies for each tenant.
in: body
required: true
type: integer
quota-router:
description: |
The number of routers allowed for each tenant.
in: body
required: true
type: integer
quota-security_group:
description: |
The number of security groups allowed for each
tenant.
in: body
required: true
type: integer
quota-security_group_rule:
description: |
The number of security group rules allowed for
each tenant.
in: body
required: true
type: integer
quota-subnet:
description: |
The number of subnets allowed for each tenant.
in: body
required: true
type: integer
quota-subnetpool:
description: |
The number of subnet pools allowed for each
tenant.
in: body
required: true
type: integer
quotas:
description: |
A list of quota objects.
in: body
required: true
type: array
rbac_policy:
description: |
The number of role-based access control (RBAC)
policies for each tenant.
in: body
required: true
type: integer
rbac_policy_1:
description: |
The number of role-based access control (RBAC)
policies for each tenant.
in: body
required: false
type: integer
remote_group_id:
description: |
The remote group UUID to associate with this
@ -3271,18 +3278,6 @@ router:external_1:
in: body
required: true
type: boolean
router_1:
description: |
The number of routers allowed for each tenant.
in: body
required: true
type: integer
router_2:
description: |
The number of routers allowed for each tenant.
in: body
required: false
type: integer
router_id_1:
description: |
The UUID of the router.
@ -3335,20 +3330,6 @@ security_group:
in: body
required: true
type: object
security_group_2:
description: |
The number of security groups allowed for each
tenant.
in: body
required: false
type: integer
security_group_4:
description: |
The number of security groups allowed for each
tenant.
in: body
required: true
type: integer
security_group_id:
description: |
The security group UUID to associate with this
@ -3368,20 +3349,6 @@ security_group_rule:
in: body
required: true
type: object
security_group_rule_1:
description: |
The number of security group rules allowed for
each tenant.
in: body
required: true
type: integer
security_group_rule_2:
description: |
The number of security group rules allowed for
each tenant.
in: body
required: false
type: integer
security_group_rules:
description: |
A list of ``security_group_rule`` objects.
@ -3713,18 +3680,6 @@ status_description:
in: body
required: true
type: string
subnet:
description: |
The number of subnets allowed for each tenant.
in: body
required: true
type: integer
subnet_1:
description: |
The number of subnets allowed for each tenant.
in: body
required: false
type: integer
subnet_id:
description: |
If you specify only a subnet UUID, OpenStack
@ -3789,20 +3744,6 @@ subnetpool:
in: body
required: true
type: object
subnetpool_1:
description: |
The number of subnet pools allowed for each
tenant.
in: body
required: true
type: integer
subnetpool_2:
description: |
The number of subnet pools allowed for each
tenant.
in: body
required: false
type: integer
subnetpools:
description: |
A list of ``subnetpool`` objects.

134
api-ref/source/v2/quotas.inc
View File

@ -8,8 +8,8 @@
Quotas extension (quotas)
=========================
Lists quotas for tenants who have non-default quota values, and
lists, updates, and resets quotas for a tenant.
Lists default quotas, current quotas for tenants who have non-default quota
values, and shows, updates, and resets quotas for a tenant.
A quota value of ``-1`` means that quota has no limit.
@ -22,7 +22,7 @@ Lists quotas for tenants who have non-default quota values.
Normal response codes: 200
Error response codes: 403,401
Error response codes: 401, 403
Request
-------
@ -32,16 +32,16 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- subnet: subnet
- network: network
- floatingip: floatingip
- subnetpool: subnetpool
- subnet: quota-subnet
- network: quota-network
- floatingip: quota-floatingip
- subnetpool: quota-subnetpool
- quotas: quotas
- security_group_rule: security_group_rule
- security_group: security_group_2
- router: router
- rbac_policy: rbac_policy
- port: port
- security_group_rule: quota-security_group_rule
- security_group: quota-security_group
- router: quota-router
- rbac_policy: quota-rbac_policy
- port: quota-port
Response Example
----------------
@ -58,30 +58,30 @@ Lists quotas for a tenant.
Normal response codes: 200
Error response codes: 404,403,401
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- tenant_id: tenant_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- subnet: subnet
- network: network
- floatingip: floatingip
- subnetpool: subnetpool
- quota: quota
- security_group_rule: security_group_rule
- security_group: security_group_2
- router: router
- rbac_policy: rbac_policy
- port: port
- subnet: quota-subnet
- network: quota-network
- floatingip: quota-floatingip
- subnetpool: quota-subnetpool
- quotas: quotas
- security_group_rule: quota-security_group_rule
- security_group: quota-security_group
- router: quota-router
- rbac_policy: quota-rbac_policy
- port: quota-port
Response Example
----------------
@ -98,23 +98,23 @@ Updates quotas for a tenant. Use when non-default quotas are desired.
Normal response codes: 200
Error response codes: 404,403,401
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- subnet: subnet
- network: network
- floatingip: floatingip
- subnetpool: subnetpool
- quota: quota
- security_group_rule: security_group_rule
- security_group: security_group_2
- router: router
- rbac_policy: rbac_policy
- port: port
- subnet: quota-subnet
- network: quota-network
- floatingip: quota-floatingip
- subnetpool: quota-subnetpool
- quotas: quotas
- security_group_rule: quota-security_group_rule
- security_group: quota-security_group
- router: quota-router
- rbac_policy: quota-rbac_policy
- port: quota-port
- tenant_id: tenant_id
Request Example
@ -128,16 +128,17 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- subnet: subnet
- network: network
- floatingip: floatingip
- subnetpool: subnetpool
- quota: quota
- security_group_rule: security_group_rule
- security_group: security_group_2
- router: router
- rbac_policy: rbac_policy
- port: port
- subnet: quota-subnet
- network: quota-network
- floatingip: quota-floatingip
- subnetpool: quota-subnetpool
- quotas: quotas
- security_group_rule: quota-security_group_rule
- security_group: quota-security_group
- router: quota-router
- rbac_policy: quota-rbac_policy
- port: quota-port
- tenant_id: tenant_id
Response Example
----------------
@ -152,12 +153,51 @@ Reset quota for a tenant
Resets quotas to default values for a tenant.
Error response codes: 404,403,204,401
Error response codes: 204, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- tenant_id: tenant_id-path
List default quotas for a tenant
================================
.. rest_method:: GET /v2.0/quotas/{tenant_id}/default
Lists default quotas for a tenant.
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- quota: quota
- floatingip: quota-floatingip
- network: quota-network
- port: quota-port
- rbac_policy: quota-rbac_policy
- router: quota-router
- security_group: quota-security_group
- security_group_rule: quota-security_group_rule
- subnet: quota-subnet
- subnetpool: quota-subnetpool
Response Example
----------------
.. literalinclude:: samples/quotas/quotas-list-for-tenant-response.json
:language: javascript