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 to 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.
For each policy types, one of the two policy_mode may be selected:
optionalwill start your Instances even if the constraint is not respectedenforcedguarantees that if the Instance starts, the constraint is respected
The policy_mode is set by default to optional.
List placement groups
List all placement groups in a specified Availability Zone.
path Parameters
zoneThe zone you want to target
query Parameters
per_pageA positive integer lower or equal to 100 to select the number of items to return.
pageA positive integer to choose the page to return.
organizationList only placement groups of this Organization ID.
projectList only placement groups of this Project ID.
tagsList placement groups with these exact tags (to filter with several tags, use commas to separate them).
nameFilter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo").
List placement groups › Responses
List of placement groups.
Create a placement group
Create a new placement group in a specified Availability Zone.
path Parameters
zoneThe zone you want to target
Create a placement group › Request Body
nameName of the placement group.
projectProject ID of the placement group.
tagsTags of the placement group.
policy_modeOperating mode of the placement group.
policy_typePolicy type of the placement group.
organizationOrganization ID of the placement group.
Create a placement group › Responses
Get a placement group
Get the 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
Set placement group
Set all parameters of the specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idSet placement group › Request Body
nameorganizationpolicy_modepolicy_typeprojecttagsSet placement group › Responses
Delete the specified placement group
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to delete.
Delete the specified placement group › Responses
Update a placement group
Update one or more parameter of the 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.
tagsTags of the placement group.
policy_modeOperating mode of the placement group.
policy_typePolicy type of the placement group.
Update a placement group › Responses
Get placement group servers
Get all Instances belonging to the specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to get.
Get placement group servers › Responses
Instances attached to the placement group.
Set placement group servers
Set all Instances belonging to the specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to set.
Set placement group servers › Request Body
serversAn array of the Instances' UUIDs you want to configure.
Set placement group servers › Responses
Instances attached to the placement group.
Update placement group servers
Update all Instances belonging to the specified placement group.
path Parameters
zoneThe zone you want to target
placement_group_idUUID of the placement group you want to update.
Update placement group servers › Request Body
serversAn array of the Instances' UUIDs you want to configure.
Update placement group servers › Responses
Instances attached to the placement group.