api-ref: Add missing parameters in limits.inc

Add missing parameters in limits.inc.
Fix inconsistency in the description ('instance' and 'server').

Change-Id: I9e361471024fd9618a7b6a7b49a1aeca810e6f05
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1654316
This commit is contained in:
Takashi NATSUME 2017-06-20 12:30:39 +09:00
parent dcea3ff687
commit 247aa22355
2 changed files with 94 additions and 10 deletions

View File

@ -17,6 +17,14 @@ Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- reserved: reserved_query
- tenant_id: tenant_id_query
Response
--------
@ -37,6 +45,12 @@ Response
- maxTotalInstances: instances
- maxTotalKeypairs: key_pairs
- maxTotalRAMSize: ram
- totalCoresUsed: total_cores_used
- totalFloatingIpsUsed: total_floatingips_used
- totalInstancesUsed: total_instances_used
- totalRAMUsed: total_ram_used
- totalSecurityGroupsUsed: total_security_groups_used
- totalServerGroupsUsed: total_server_groups_used
- rate: limits_rates
**Example Show Rate And Absolute Limits: JSON response**

View File

@ -789,6 +789,18 @@ reservation_id_query:
type: string
description: |
A reservation id as returned by a servers multiple create call.
reserved_query:
description: |
Specify whether the result of resource total includes reserved resources
or not.
- ``0``: Not include reserved resources.
- Other than 0: Include reserved resources.
If non integer value is specified, it is the same as ``0``.
in: query
required: false
type: integer
server_name_query:
description: |
Filters the response by a server name, as a string. You can use regular expressions
@ -940,6 +952,13 @@ task_state_query_server:
type: string
description: |
Filter the server list result by task state.
tenant_id_query:
description: |
Specify the project ID (tenant ID) to show the rate and absolute limits.
This parameter can be specified by admin only.
in: query
required: false
type: string
terminated_at_query_server:
description: |
Filter the server list result by a date and time stamp when instance was terminated.
@ -1611,7 +1630,7 @@ contents:
type: string
cores: &cores
description: |
The number of allowed instance cores for each tenant.
The number of allowed server cores for each tenant.
in: body
required: true
type: integer
@ -1631,7 +1650,7 @@ cores_quota_details:
type: object
cores_quota_optional:
description: |
The number of allowed instance cores for each tenant.
The number of allowed server cores for each tenant.
in: body
required: false
type: integer
@ -2183,7 +2202,7 @@ fixed_ips_quota_details:
fixed_ips_quota_optional:
description: |
The number of allowed fixed IP addresses for each tenant. Must be equal to or
greater than the number of allowed instances.
greater than the number of allowed servers.
in: body
required: false
type: integer
@ -3171,14 +3190,14 @@ instances_quota_class_optional:
required: false
instances_quota_details:
description: |
The object of detailed instances quota, including in_use, limit and
The object of detailed servers quota, including in_use, limit and
reserved number of instances.
in: body
required: true
type: object
instances_quota_optional:
description: |
The number of allowed instances for each tenant.
The number of allowed servers for each tenant.
in: body
required: false
type: integer
@ -3411,7 +3430,8 @@ limits:
type: object
limits_absolutes:
description: |
Name/value pairs that set quota limits within a deployment.
Name/value pairs that set quota limits within a deployment and
Name/value pairs of resource usage.
in: body
required: true
type: object
@ -3576,7 +3596,7 @@ metadata_compat:
type: object
metadata_items:
description: |
The number of allowed metadata items for each instance.
The number of allowed metadata items for each server.
in: body
required: true
type: integer
@ -3589,7 +3609,7 @@ metadata_items_quota_details:
type: object
metadata_items_quota_optional:
description: |
The number of allowed metadata items for each instance.
The number of allowed metadata items for each server.
in: body
required: false
type: integer
@ -4387,7 +4407,7 @@ quota_tenant_or_user_id_body:
type: string
ram: &ram
description: |
The amount of allowed instance RAM, in MB, for each tenant.
The amount of allowed server RAM, in MB, for each tenant.
in: body
required: true
type: integer
@ -4407,7 +4427,7 @@ ram_quota_details:
type: object
ram_quota_optional:
description: |
The amount of allowed instance RAM, in MB, for each tenant.
The amount of allowed server RAM, in MB, for each tenant.
in: body
required: false
type: integer
@ -5185,12 +5205,29 @@ to_port:
in: body
required: true
type: integer
total_cores_used:
description: |
The number of used server cores in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the number of reserved server cores are also included.
in: body
required: true
type: integer
total_errors:
description: |
The total number of instance audit task errors.
in: body
required: true
type: integer
total_floatingips_used:
description: |
The number of used floating IP addresses in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the number of reserved floating IP addresses are also included.
in: body
required: true
type: integer
max_version: 2.35
total_hours:
description: |
The total duration that servers exist (in hours).
@ -5203,6 +5240,14 @@ total_instances:
in: body
required: true
type: integer
total_instances_used:
description: |
The number of servers in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the number of reserved servers are also included.
in: body
required: true
type: integer
total_local_gb_usage:
description: |
Multiplying the server disk size (in GiB) by hours the server exists,
@ -5217,6 +5262,31 @@ total_memory_mb_usage:
in: body
required: true
type: float
total_ram_used:
description: |
The amount of used server RAM in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the amount of reserved server RAM is also included.
in: body
required: true
type: integer
total_security_groups_used:
description: |
The number of used security groups in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the number of reserved security groups are also included.
in: body
required: true
type: integer
max_version: 2.35
total_server_groups_used:
description: |
The number of used server groups in each tenant.
If ``reserved`` query parameter is specified and it is not 0,
the number of reserved server groups are also included.
in: body
required: true
type: integer
total_vcpus_usage:
description: |
Multiplying the number of virtual CPUs of the server by hours the server exists,