placement/placement-api-ref/source/resource_provider_allocations.inc
Takashi NATSUME ccc6a3c009 [placement] Move body examples to an isolated directory
JSON body examples of Placement API reference
are in the same directroy where *.inc files exist.

This patch moves JSON body examples to an isolated directory
in order to make it easier to maintain the API reference.

Change-Id: I8fd587100d22bd10dd4b2b2f1b25c5ecc7fc8537
2018-02-08 21:59:19 +00:00

41 lines
964 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:: ./samples/resource_provider_allocations/get-resource_provider_allocations.json
:language: javascript