Reservations

List a node's reservable GPU units

Changed on

Returns the allocatable GPU units on one node, with the unit ids that create, release, and reclaim take, and whether each unit can be reserved. Without this those calls are unusable: they are unit-scoped by design, and nothing else on the API returns a unit id, so the first reservation on a node could not be written at all. Each unit is one IOMMU group and is indivisible: a paired unit sells its GPUs together. Sellable units of a reservable class (vfio-group for VMs, device-request for pods) are reservable, and the response says which, and why not, rather than leaving the caller to infer it from a rejection. Readable by a platform operator, the org that owns the node, and any org managing a reservation on it. Anyone else gets 404, so the fleet stays unenumerable.

Requires the reservation.read permission. A caller without it gets 404. See Permissions for the roles and API key permissions that include it.

get/v1/nodes/{nodeId}/reservations/units

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/nodes/{nodeId}/reservations/units
  • Auth
    HTTP bearer

Path parameters

nodeIdstring required

Response

OK

allocClassstring required

vfio-group is the VM passthrough path; device-request is the pod path. Both are reservable when sellable.

claimedBystring

What holds it, e.g. vm:<id>. Present when claimed.

gpuModelIdstring required
gpuModelNamestring
idstring required

Unit id, e.g. 0000:04:00.0. Pass this to create/release/reclaim.

notReservableReasonstring

Why not, when reservable is false.

releasedboolean

On the spot market right now (double sell).

reservableboolean required

Whether this unit can be put in a reservation.

reservationIdstring

The reservation governing it, when any.

sellableGpusinteger required

GPUs this unit sells; indivisible, they go together

statestring required

free | claimed

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status