placement/releasenotes/notes/allocation_candidates_support_member_of-92f7e1440ed63fe7.yaml
Ed Leafe 64b404be09 Add 'member_of' param to GET /allocation_candidates
The call to GET /allocation_candidates now accepts a 'member_of'
parameter, representing one or more aggregate UUIDs. If this parameter
is supplied, the allocation_candidates returned will be limited to those
with resource_providers that belong to at least one of the supplied
aggregates.

Blueprint: alloc-candidates-member-of

Change-Id: I5857e927a830914c96e040936804e322baccc24c
2018-03-16 16:32:02 +00:00

14 lines
783 B
YAML

---
features:
- |
Add support, in a new placement microversion 1.21, for the ``member_of``
query parameter, representing one or more aggregate UUIDs. When supplied,
it will filter the returned allocation candidates to only those
resource_providers that are associated with ("members of") the specified
aggregate(s). This parameter can have a value of either a single aggregate
UUID, or a comma-separated list of aggregate UUIDs. When specifying more
than one aggregate, a resource provider needs to be associated with at
least one of the aggregates in order to be included; it does not have to be
associated with all of them. Because of this, the list of UUIDs must be
prefixed with ``in:`` to represent the logical ``OR`` of the selection.