Assign a placement group

post https://api.linode.com/{apiVersion}/placement/groups/{groupId}/assign

Add one or more compute instances to your placement group. Check out our example API workflow to create a placement group and add compute instances.

linode-cli placement assign-linode 528 \
  --linodes 123 456 \
  --non-compliant true


Learn more...

linodes:read_write


Learn more...

Responses

Response body

object

integer

The placement group's ID. You need to provide it for all operations that affect it.

is_compliant

boolean

Whether all of the compute instances in your placement group are compliant. If true, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected placement_group_type. If false, a compute instance is out of this compliance. For example, assume you've set anti-affinity:local as your placement_group_type and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a placement_group_policy.

📘
Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.

label

string

length ≥ 1

Filterable The unique name set for the placement group. A label has these constraints:

It needs to begin and end with an alphanumeric character.
It can only consist of alphanumeric characters, hyphens (-), underscores (_) or periods (.).

members

array of objects

An array of compute instances included in the placement group.

members

object

is_compliant

boolean

The compliance status of each individual compute instance in the placement group.

linode_id

integer

Read-only The unique identifier for a compute instance included in the placement group.

placement_group_policy

string

How requests to add future compute instances to your placement group are handled, and whether it remains compliant:

strict. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the placement_group_type. Use this to ensure the placement group stays compliant (is_compliant: true).
flexible. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the placement_group_type. This makes the group non-compliant (is_compliant: false). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.

📘
In rare cases, non-compliance can occur with a strict placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a strict placement group is prioritized over a flexible group.

strict flexible

placement_group_type

string

Filterable, Read-only How compute instances are distributed in your placement group. A placement_group_type using anti-affinity (anti-affinity:local) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A placement_group_type using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.

📘
Currently, only anti_affinity:local is available for placement_group_type.

anti_affinity:local

region

string

Filterable, Read-only The region where the placement group was deployed.

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.linode.com/v4/placement/groups/groupId/assign \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
14
 
1
{
2
  "id": 528,
3
  "is_compliant": true,
4
  "label": "PG_Miami_failover",
5
  "members": [
6
    {
7
      "is_compliant": true,
8
      "linode_id": 123
9
    }
10
  ],
11
  "placement_group_policy": "strict",
12
  "placement_group_type": "anti-affinity:local",
13
  "region": "us-mia"
14
}

200The compute instance was added successfully.

📘

📘

📘

defaultSee Errors for the range of possible error response codes.