nova/placement-api-ref/source/resource_provider_usages.inc
jichenjc 4db481592d [placement] Add api-ref for RP usages
Add placement-api-ref for resource provider usages.

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

Change-Id: I6ba8765a427f654dafb32fc3fbf5492b0e1b426a
2017-08-10 09:37:27 +00:00

43 lines
1.0 KiB
PHP

========================
Resource provider usages
========================
Show the consumption of resources for a resource provider
in an aggregated form, i.e. without information for a particular consumer.
See `Resource provider allocations`_.
List resource provider usages
=============================
Return a report of usage information for resources associated with
the resource provider identified by `{uuid}`. The value is a dictionary
of resource classes paired with the sum of the allocations of that
resource class for this resource provider.
.. rest_method:: GET /resource_providers/{uuid}/usages
Normal Response Codes: 200
Error response codes: itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- uuid: resource_provider_uuid_path
Response
--------
.. rest_parameters:: parameters.yaml
- resource_provider_generation: resource_provider_generation
- usages: resource_provider_usages
Response Example
----------------
.. literalinclude:: get-resource_provider_usages.json
:language: javascript