Get placement group

GET /cloud/v1/servergroups/{project_id}/{region_id}/{group_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
placement_group = client.cloud.placement_groups.get(
    group_id="group_id",
    project_id=0,
    region_id=0,
)
print(placement_group.project_id)

200

{
  "instances": [
    {
      "instance_id": "6d14f194-6c1e-49b3-9fc7-50dc8401eb74",
      "instance_name": "my-instance-1"
    },
    {
      "instance_id": "142988bb-291e-4862-bffb-b1cf20036c27",
      "instance_name": "my-instance-2"
    }
  ],
  "name": "my-server-group",
  "policy": "anti-affinity",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "servergroup_id": "47003067-550a-6f17-93b6-81ee16ba061e"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

region_id · integer · required

Region ID

group_id · string · required

Placement group ID

Response

200 - application/json

Returned placement group

instances · Instance brief details schema · object[] · required

The list of instances in this server group.

Show child attributes

Example:

[
  {
    "instance_id": "6d14f194-6c1e-49b3-9fc7-50dc8401eb74",
    "instance_name": "my-instance-1"
  },
  {
    "instance_id": "142988bb-291e-4862-bffb-b1cf20036c27",
    "instance_name": "my-instance-2"
  }
]

name · string · required

The name of the server group.

Example:

"my-server-group"

policy · string · required

The server group policy. Options are: anti-affinity, affinity, or soft-anti-affinity.

Example:

"anti-affinity"

project_id · integer · required

Project ID

Example:

1337

region · string · required

Region name

Example:

"Luxembourg 1"

region_id · integer · required

Region ID

Example:

7

servergroup_id · string · required

The ID of the server group.

Example:

"47003067-550a-6f17-93b6-81ee16ba061e"