Get bare metal GPU cluster server console URL

GET /cloud/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console

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
)
console = client.cloud.gpu_baremetal.clusters.servers.get_console(
    instance_id="instance_id",
    project_id=0,
    region_id=0,
)
print(console.remote_console)

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"),
	)
	console, err := client.Cloud.GPUBaremetal.Clusters.Servers.GetConsole(
		context.TODO(),
		"instance_id",
		cloud.GPUBaremetalClusterServerGetConsoleParams{
			ProjectID: gcore.Int(0),
			RegionID:  gcore.Int(0),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", console.RemoteConsole)
}

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

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

fetch('https://api.gcore.com/cloud/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console', 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/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console",
  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/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/ai/clusters/{project_id}/{region_id}/{instance_id}/get_console")

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

{
  "remote_console": {
    "protocol": "<string>",
    "type": "<string>",
    "url": "<string>"
  }
}

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

instance_id · string · required

Instance ID

Response

200

application/json

Remote console data

remote_console · RemoteConsoleData · object · required

Remote console information

Show child attributes

Example:

{
  "protocol": "vnc",
  "type": "novnc",
  "url": "https://console-novnc.example.com/vnc_auto.html?path=%3Ftoken%3Df445c4b6-0a77-4fae-bc0e-147201dbfbea"
}