List placement groups

GET /cloud/v1/servergroups/{project_id}/{region_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_list = client.cloud.placement_groups.list(
    project_id=0,
    region_id=0,
)
print(placement_group_list.count)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/cloud"
	"github.com/G-Core/gcore-go/option"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	placementGroupList, err := client.Cloud.PlacementGroups.List(context.TODO(), cloud.PlacementGroupListParams{
		ProjectID: gcore.Int(0),
		RegionID:  gcore.Int(0),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", placementGroupList.Count)
}

curl --request GET \
  --url https://api.gcore.com/cloud/v1/servergroups/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v1/servergroups/{project_id}/{region_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/servergroups/{project_id}/{region_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/servergroups/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/servergroups/{project_id}/{region_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "count": 1,
  "results": [
    {
      "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

Response

200 - application/json

List of placement groups

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · Server group schema · object[] · required

Objects

Show child attributes