Skip to main content
PATCH
/
cloud
/
v3
/
gpu
/
virtual
/
{project_id}
/
{region_id}
/
clusters
/
{cluster_id}
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
)
gpu_virtual_cluster = client.cloud.gpu_virtual_clusters.update(
    cluster_id="1aaaab48-10d0-46d9-80cc-85209284ceb4",
    project_id=1,
    region_id=7,
    name="gpu-cluster-1",
)
print(gpu_virtual_cluster.id)
{
  "created_at": "2023-11-07T05:31:56Z",
  "flavor": "<string>",
  "id": "<string>",
  "name": "<string>",
  "servers_count": 123,
  "servers_ids": [
    "<string>"
  ],
  "servers_settings": {
    "file_shares": [
      {
        "id": "<string>",
        "mount_path": "<string>"
      }
    ],
    "interfaces": [
      {
        "ip_family": "dual",
        "name": "eth0",
        "type": "<string>"
      }
    ],
    "security_groups": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "ssh_key_name": "my-ssh-key",
    "user_data": "eyJ0ZXN0IjogImRhdGEifQ==",
    "volumes": [
      {
        "boot_index": 1,
        "delete_on_termination": true,
        "image_id": "3793c250-0b3b-4678-bab3-e11afbc29657",
        "name": "<string>",
        "size": 123,
        "tags": [
          {
            "key": "<string>",
            "read_only": true,
            "value": "<string>"
          }
        ],
        "type": "cold"
      }
    ]
  },
  "status": "active",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "updated_at": "2025-01-11T23:59:59Z"
}

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

cluster_id
string<uuid4>
required

Cluster unique identifier

Body

application/json
name
string
required

Cluster name

Maximum string length: 256

Response

200 - application/json

OK

created_at
string<date-time>
required

Cluster creation date time

flavor
string
required

Cluster flavor name

id
string<uuid4>
required

Cluster unique identifier

name
string
required

Cluster name

servers_count
integer
required

Cluster servers count

servers_ids
string<uuid4>[]
required

List of cluster nodes

servers_settings
VirtualServerSettingsOutputSerializer · object
required
status
enum<string>
required

Cluster status

Available options:
active,
deleting,
error,
new,
resizing
tags
TagSerializer · object[]
required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

updated_at
string<date-time> | null
required

Cluster update date time

Example:

"2025-01-11T23:59:59Z"