Placement Groups
Placement groups allow the user to express a preference regarding the physical position of a group of Instances. The feature lets the user choose to either group Instances on the same physical hardware for best network throughput and low latency, or spread Instances across physically distanced hardware to reduce the risk of physical failure.
The operating mode is selected by a policy_type. Two policy
types are available:
low_latencywill group Instances on the same hypervisorsmax_availabilitywill spread Instances across physically distanced hypervisors
The policy_type is set to max_availability by default.
List placement groups
List all placement groups.
path Parameters
zoneThe zone you want to target
query Parameters
project_idList only placement groups of this Project ID.
page_tokenThe initial pagination token to start from.
page_sizeThe maximum number of placement groups to return.
order_byThe field by which to order the result list.
placement_group_idsList only placement groups with these IDs.
nameFilter placement groups by name.
tagsList placement groups with these exact tags.
List placement groups › Responses
List of placement groups.
next_page_tokenThe pagination token, use it to get the next page of results.
total_countTotal number of placement groups.
Create a placement group
Create a new placement group.
path Parameters
zoneThe zone you want to target
Create a placement group › Request Body
project_idProject ID of the placement group.
nameName of the placement group.
policy_typePolicy type of the placement group.
tagsTags of the placement group.
Create a placement group › Responses
idPlacement group unique ID.
project_idPlacement group Project ID.
namePlacement group name.
policy_typeSelect the behavior of the placement group, either low_latency (group) or max_availability (spread).
tagsPlacement group tags.
created_atPlacement group creation date. (RFC 3339 format)
updated_atPlacement group modification date. (RFC 3339 format)
zoneZone in which the placement group is located.
Get a placement group
Get a specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to get.
Get a placement group › Responses
idPlacement group unique ID.
project_idPlacement group Project ID.
namePlacement group name.
policy_typeSelect the behavior of the placement group, either low_latency (group) or max_availability (spread).
tagsPlacement group tags.
created_atPlacement group creation date. (RFC 3339 format)
updated_atPlacement group modification date. (RFC 3339 format)
zoneZone in which the placement group is located.
Delete a placement group
Delete a specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to delete.
Delete a placement group › Responses
Update a placement group
Update the properties of a specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group.
Update a placement group › Request Body
nameName of the placement group.
policy_typePolicy type of the placement group.
tagsTags of the placement group.
Update a placement group › Responses
idPlacement group unique ID.
project_idPlacement group Project ID.
namePlacement group name.
policy_typeSelect the behavior of the placement group, either low_latency (group) or max_availability (spread).
tagsPlacement group tags.
created_atPlacement group creation date. (RFC 3339 format)
updated_atPlacement group modification date. (RFC 3339 format)
zoneZone in which the placement group is located.