nova/placement-api-ref/source/resource_provider_allocations.inc
Andrey Volkov 5f3e136e25 [placement] Add api-ref for RP allocations
This provides simple documentation of the path and response
body parameters when listing resource provider allocations.

Co-Authored-by: Andrey Volkov <avolkov@gmail.com>

Change-Id: I40fcbc3077151227f33c6a021229b5c549889bbe
2017-08-07 12:06:53 +03:00

41 lines
924 B
HTML

=============================
Resource provider allocations
=============================
See `Allocations`_ for a description.
List resource provider allocations
==================================
Return a representation of all allocations made against this resource
provider, keyed by consumer uuid. Each allocation includes one or more
classes of resource and the amount consumed.
.. rest_method:: GET /resource_providers/{uuid}/allocations
Normal Response Codes: 200
Error response codes: itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- uuid: resource_provider_uuid_path
Response
--------
.. rest_parameters:: parameters.yaml
- allocations: resource_provider_allocations
- resources: resources
- resource_provider_generation: resource_provider_generation
Response Example
----------------
.. literalinclude:: get-resource_provider_allocations.json
:language: javascript