Sign in
GPUClusterService

Get GPU cluster by cluster ID

Retrieve information about a specific GPU cluster.

get/compute/clusters/{cluster_id}

Path parameters

cluster_idstring required

The ID of the cluster to retrieve

Response

OK

cluster_idstring required
cluster_type'KUBERNETES' | 'SLURM' required

Type of cluster.

regionstring required
gpu_type'H100_SXM' | 'H200_SXM' | 'RTX_6000_PCI' | 'L40_PCIE' | 'B200_SXM' | 'H100_SXM_INF' | 'B300_SXM' required
cluster_namestring required
duration_hoursinteger
status'WaitingForControlPlaneNodes' | 'WaitingForDataPlaneNodes' | 'WaitingForSubnet' | 'WaitingForSharedVolume' | 'InstallingDrivers' | 'RunningAcceptanceTests' | 'Paused' | 'OnDemandComputePaused' | 'Ready' | 'Degraded' | 'Deleting' required

Current status of the GPU cluster.

kube_configstring required
num_gpusinteger required
slurm_shm_size_gibinteger
capacity_pool_idstring
reservation_start_timestring date-time
reservation_end_timestring date-time
install_traefikboolean
cuda_versionstring required
nvidia_driver_versionstring required
created_atstring date-time
project_idstring required
num_cpu_workersinteger required

Number of CPU-only worker nodes in the cluster.

desired_preemptible_gpusinteger required

Customer's requested number of preemptible GPUs. Set on cluster create or update; persists until changed.

allocated_preemptible_gpusinteger required

Actual number of preemptible GPUs currently allocated to the cluster. Updated asynchronously by the fulfillment and reclamation workers; may be less than desired_preemptible_gpus when capacity is constrained.

billing_type'RESERVED' | 'ON_DEMAND' | 'SCHEDULED_CAPACITY' required

Billing type for the cluster (RESERVED, ON_DEMAND, or SCHEDULED_CAPACITY).

machine_cluster_idstring

ID of the machine cluster backing this GPU cluster.

first_ready_atstring date-time

Timestamp when the cluster first reached the Ready phase.

is_in_substrateboolean

Whether the cluster is managed inside a substrate environment.

control_plane_readyboolean

Whether the control plane is currently ready.

ums_project_idstring

UMS project ID associated with this cluster.

ums_org_idstring

UMS organization ID associated with this cluster.

os_imagestring

Data-volume image name for GPU worker nodes.

nvidia_driver_version_idstring

Internal NVIDIA version ID for this cluster's driver and CUDA combination.

num_capacity_pool_gpusinteger required

Number of GPUs to draw from a capacity pool. A component of the overall num_gpus, alongside num_reserved_gpus.

num_reserved_gpusinteger required

Number of prepaid reserved GPUs for this cluster. A component of the overall num_gpus, alongside num_capacity_pool_gpus.

Changes

Changed in 3 of the 14 revisions of this API.776

  • 3ad4ab3289482See the full diff
    • ○

      added the required property deleted_gpu_worker_nodes/items/latest_remediation/linked_alerts/items/annotation to the response with the 200 status

      response-required-property-added

    • ○

      added the required property gpu_worker_nodes/items/latest_remediation/linked_alerts/items/annotation to the response with the 200 status

      response-required-property-added

  • ebd4756a41e41See the full diff
    • ●

      added the new B300_SXM enum value to the gpu_type response property for the response status 200

      response-property-enum-value-added

  • 0c4fdad77435764See the full diff
    • ▲

      the allocated_preemptible_gpus response's property type/format changed from integer/int32 to integer/ for status 200

      response-property-type-changed

    • ▲

      the control_plane_nodes/items/memory_gib response's property type/format changed from number/float to number/ for status 200

      response-property-type-changed

    • ▲

      the deleted_gpu_worker_nodes/items/memory_gib response's property type/format changed from number/float to number/ for status 200

      response-property-type-changed

    • ▲

      the desired_preemptible_gpus response's property type/format changed from integer/int32 to integer/ for status 200

      response-property-type-changed

    • ▲

      the gpu_worker_nodes/items/memory_gib response's property type/format changed from number/float to number/ for status 200

      response-property-type-changed

    • ▲

      the num_cpu_workers response's property type/format changed from integer/int32 to integer/ for status 200

      response-property-type-changed

    • ▲

      the num_gpus response's property type/format changed from integer/int32 to integer/ for status 200

      response-property-type-changed

    • ●

      added the new QUARANTINED enum value to the deleted_gpu_worker_nodes/items/latest_remediation/state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new QUARANTINED enum value to the gpu_worker_nodes/items/latest_remediation/state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new QUARANTINING enum value to the deleted_gpu_worker_nodes/items/latest_remediation/state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new QUARANTINING enum value to the gpu_worker_nodes/items/latest_remediation/state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new REMEDIATION_MODE_HOST_POWER_CYCLE enum value to the deleted_gpu_worker_nodes/items/latest_remediation/mode response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new REMEDIATION_MODE_HOST_POWER_CYCLE enum value to the gpu_worker_nodes/items/latest_remediation/mode response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property add_ons/items/config/headlamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property add_ons/items/config/slurm_web to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property add_ons/items/state/headlamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property add_ons/items/state/slurm_web to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog