Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Clusters

Get clusters

Return all clusters of the project

get/v1/clusters

Response

List of clusters

idstring required
ipstring required

Jump host IP address

status'running' | 'provisioning' | 'offline' | 'discontinued' | 'unknown' | 'ordered' | 'notfound' | 'new' | 'error' | 'deleting' | 'validating' | 'no_capacity' | 'installation_failed' required
created_atstring required
created_by_user_idstring
cpuobject required
gpuobject required
gpu_memoryobject required
memoryobject required
hostnamestring required
descriptionstring required
locationstring required
price_per_hournumber required
cluster_typestring required
imagestring required

OS image used to deploy the cluster nodes

os_namestring required
startup_script_idstring
ssh_key_idsstring[] required

SSH key IDs used to access the cluster jump host

contract'LONG_TERM' | 'PAY_AS_YOU_GO' required

Contract type used for this cluster

auto_rental_extensionboolean

Deprecated: use extension_settings instead.

turn_to_pay_as_you_goboolean

Deprecated: use extension_settings instead.

extension_settings'auto_renew' | 'pay_as_you_go' | 'end_contract'

Extension settings for long-term contracts

long_term_periodstring

Long-term rental period for this cluster, e.g. 1 week etc.

worker_nodesstring[]

Worker nodes of this cluster. You can access them from the jump host by executing ssh <hostname>

shared_volumesstring[]

Shared volumes attached to this cluster. There is always one shared volume mounted as /home.

Example response

[
  {
    "id": "c41def26-f1b3-47c2-bd95-3bb6b41e7a27",
    "ip": "1.2.3.4",
    "status": "running",
    "created_at": "2023-07-15T14:10:26.654Z",
    "created_by_user_id": "7dfc2631-0158-4f74-93f6-6b46dcb90fef",
    "cpu": {
      "description": "176 CPU",
      "number_of_cores": 176,
      "model": "AMD Genoa"
    },
    "gpu": {
      "description": "8x A100",
      "number_of_gpus": 8
    },
    "gpu_memory": {
      "description": "80GB GPU RAM",
      "size_in_gigabytes": 80
    },
    "memory": {
      "description": "640GB RAM",
      "size_in_gigabytes": 640
    },
    "hostname": "hazy-star-swims-fin-01",
    "description": "ubuntu-22-04-cuda-12-0-docker-fin-01",
    "tags": [
      {
        "id": "tag_0aB1cD2eF3gH4iJ5kL6mN7",
        "key": "environment",
        "value": "production"
      }
    ],
    "location": "FIN-01",
    "price_per_hour": 2.481,
    "cluster_type": "16H200",
    "image": "ubuntu-22-04-cuda-12-0-docker",
    "os_name": "Ubuntu 22.04",
    "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea",
    "ssh_key_ids": [
      "dd50b622-1c36-48c2-a485-f4d4937a3ea1"
    ],
    "contract": "LONG_TERM",
    "long_term_period": "1 week",
    "worker_nodes": [
      {
        "id": "1",
        "hostname": "worker-1",
        "public_ip": "1.2.3.4",
        "private_ip": "1.2.3.4",
        "status": "running"
      }
    ],
    "shared_volumes": [
      {
        "id": "1",
        "name": "shared-volume-1",
        "mount_point": "/home",
        "size_in_gigabytes": 100
      }
    ]
  }
]