List virtual GPU clusters

List all virtual GPU clusters in the specified project and region.

GET /cloud/v3/gpu/virtual/{project_id}/{region_id}/clusters

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
)
page = client.cloud.gpu_virtual_clusters.list(
    project_id=1,
    region_id=7,
)
page = page.results[0]
print(page.id)

200

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

Example:

1

region_id · integer · required

Region ID

Example:

7

Query Parameters

limit · integer · default: 10

Limit of items on a single page

Required range: x <= 1000

Example:

10

offset · integer · default: 0

Offset in results list

Required range: x >= 0

Example:

0

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · VirtualClusterSerializer · object[] · required

Objects

Show child attributes