Placement Groups

Download schema

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_latency will group Instances on the same hypervisors
max_availability will spread Instances across physically distanced hypervisors

The policy_type is set to max_availability by default.

List placement groups

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/placement-groups

List all placement groups.

List placement groups › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List placement groups › query Parameters

project_id

string · required

List only placement groups of this Project ID.

page_token

string

The initial pagination token to start from.

page_size

integer · uint32

The maximum number of placement groups to return.

order_by

scaleway.instance.v2alpha1.ListPlacementGroupsRequest.OrderBy · enum

The field by which to order the result list.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

placement_group_ids

string[]

List only placement groups with these IDs.

name

string

Filter placement groups by name.

tags

string[]

List placement groups with these exact tags.

List placement groups › Responses

200

scaleway.instance.v2alpha1.ListPlacementGroupsResponse

scaleway.instance.v2alpha1.PlacementGroup[]

List of placement groups.

next_page_token

string | null

The pagination token, use it to get the next page of results.

total_count

integer · uint64

Total number of placement groups.

Create a placement group

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/placement-groups

Create a new placement group.

Create a placement group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Create a placement group › Request Body

project_id

string

Project ID of the placement group.

name

string

Name of the placement group.

policy_type

scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Policy type of the placement group.

Enum values:

unknown_policy_type

low_latency

max_availability

Default: unknown_policy_type

tags

string[]

Tags of the placement group.

Create a placement group › Responses

200

scaleway.instance.v2alpha1.PlacementGroup

id

string

Placement group unique ID.

srn

string

The SRN of the placement group.

project_id

string

Placement group Project ID.

name

string

Placement group name.

policy_type

scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Select the behavior of the placement group, either low_latency (group) or max_availability (spread).

Enum values:

unknown_policy_type

low_latency

max_availability

Default: unknown_policy_type

tags

string[]

Placement group tags.

created_at

string | null · date-time

Placement group creation date. (RFC 3339 format)

updated_at

string | null · date-time

Placement group modification date. (RFC 3339 format)

zone

string

Zone in which the placement group is located.

Get a placement group

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/placement-groups/{placement_group_id}

Get a specified placement group.

Get a placement group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

placement_group_id

string · required

UUID of the placement group you want to get.

Get a placement group › Responses

200

scaleway.instance.v2alpha1.PlacementGroup

id

string

Placement group unique ID.

srn

string

The SRN of the placement group.

project_id

string

Placement group Project ID.

name

string

Placement group name.

policy_type

scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Select the behavior of the placement group, either low_latency (group) or max_availability (spread).

Enum values:

unknown_policy_type

low_latency

max_availability

Default: unknown_policy_type

tags

string[]

Placement group tags.

created_at

string | null · date-time

Placement group creation date. (RFC 3339 format)

updated_at

string | null · date-time

Placement group modification date. (RFC 3339 format)

zone

string

Zone in which the placement group is located.

Delete a placement group

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/placement-groups/{placement_group_id}

Delete a specified placement group.

Delete a placement group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

placement_group_id

string · required

UUID of the placement group you want to delete.

Delete a placement group › Responses

No data returned

Update a placement group

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/placement-groups/{placement_group_id}

Update the properties of a specified placement group.

Update a placement group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

placement_group_id

string · required

UUID of the placement group.

Update a placement group › Request Body

name

string | null

Name of the placement group.

policy_type

scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Policy type of the placement group.

Enum values:

unknown_policy_type

low_latency

max_availability

Default: unknown_policy_type

tags

array | null

Tags of the placement group.

Update a placement group › Responses

200

scaleway.instance.v2alpha1.PlacementGroup

id

string

Placement group unique ID.

srn

string

The SRN of the placement group.

project_id

string

Placement group Project ID.

name

string

Placement group name.

policy_type

scaleway.instance.v2alpha1.PlacementGroup.PolicyType · enum

Select the behavior of the placement group, either low_latency (group) or max_availability (spread).

Enum values:

unknown_policy_type

low_latency

max_availability

Default: unknown_policy_type

tags

string[]

Placement group tags.

created_at

string | null · date-time

Placement group creation date. (RFC 3339 format)

updated_at

string | null · date-time

Placement group modification date. (RFC 3339 format)

zone

string

Zone in which the placement group is located.

Private Network Interfaces Security Groups