8a307bbdf4
This patch add new query parameter `required` to the `GET /allocation_candidates` API, which is used to filter candidates with required traits. The candidate attached traits return in the provider summary also. Those API changes are added by new microversion. Also using specific exception TraitNotFound instead of the generic exception ValueError when invalid traits in the request. Change-Id: Id821b5b2768dcc698695ba6570c6201e1e9a8233 Implement blueprint add-trait-support-in-allocation-candidates
73 lines
2.1 KiB
PHP
73 lines
2.1 KiB
PHP
=====================
|
|
Allocation candidates
|
|
=====================
|
|
|
|
.. note:: Allocation candidates API requests are availiable starting from version 1.10.
|
|
|
|
List allocation candidates
|
|
==========================
|
|
|
|
Returns a dictionary representing a collection of allocation requests
|
|
and resource provider summaries. Each allocation request has
|
|
information to form a ``PUT /allocations/{consumer_uuid}`` request to claim
|
|
resources against a related set of resource providers. Additional parameters
|
|
might be required, see `Update allocations`_. As several allocation
|
|
requests are available it's necessary to select one. To make a
|
|
decision, resource provider summaries are provided with the
|
|
inventory/capacity information. For example, this information is used by
|
|
nova-scheduler's FilterScheduler to make decisions about on which compute host
|
|
to build a server.
|
|
|
|
.. rest_method:: GET /allocation_candidates
|
|
|
|
Normal Response Codes: 200
|
|
|
|
Error response codes: badRequest(400)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- resources: resources_query_required
|
|
- limit: allocation_candidates_limit
|
|
- required: allocation_candidates_required
|
|
|
|
Response (microversions 1.12 - )
|
|
--------------------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- allocation_requests: allocation_requests
|
|
- provider_summaries: provider_summaries
|
|
- allocations: allocations_by_resource_provider
|
|
- resources: resources
|
|
- capacity: capacity
|
|
- used: used
|
|
|
|
Response Example (microversions 1.12 - )
|
|
----------------------------------------
|
|
|
|
.. literalinclude:: get-allocation_candidates-1.12.json
|
|
:language: javascript
|
|
|
|
Response (microversions 1.10 - 1.11)
|
|
------------------------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- allocation_requests: allocation_requests
|
|
- provider_summaries: provider_summaries
|
|
- allocations: allocations_array
|
|
- resource_provider: resource_provider_object
|
|
- uuid: resource_provider_uuid
|
|
- resources: resources
|
|
- capacity: capacity
|
|
- used: used
|
|
|
|
Response Example (microversions 1.10 - 1.11)
|
|
--------------------------------------------
|
|
|
|
.. literalinclude:: get-allocation_candidates.json
|
|
:language: javascript
|