Reservations

Amend a reservation (platform admin)

Changed on

Changes a reservation's term end, audience, or managing orgs, or re-pins it to the node's current topology, and returns the updated reservation. Re-pinning (reaffirm) also reactivates a reservation in needs-review. The start of the term is fixed at create.

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

patch/v1/nodes/{nodeId}/reservations/{id}

Request

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

Path parameters

nodeIdstring required
idstring required

Request body

allowedOrgIdsstring[]

Replace the audience

endsAtstring

Move the term end. Empty string makes it open-ended.

managingOrgIdsstring[]

Replace the managing orgs. An empty array removes the delegation.

reaffirmboolean

Re-pin to the node's current topology and reactivate (clears needs-review)

Response

OK

allowedOrgIdsstring[] required

The audience: orgs that may place workloads on the reserved units.

contractRefstring
createdAtstring
endsAtstring

Absent = open-ended until cancelled

idstring required
managingOrgIdsstring[]

Orgs that may release these units to the market, reclaim them, and terminate the spot workloads on them, on the node owner's behalf, while the reservation is active and inside its term. Being in the audience does not confer this.

nodeIdstring required
reasonstring
releasedUnitIdsstring[]

The subset of reservedUnitIds currently on the spot market (double sell). Still this reservation's capacity, sellable to anyone at tier=spot only, and reclaimable at any time.

reservedUnitIdsstring[] required
skippedstring[]

Reclaim only: VM ids left running because they are not spot.

startsAtstring required
status'pending' | 'active' | 'expired' | 'cancelled' | 'needs-review' required

needs-review means the node's GPU topology changed under the reservation: it grants nothing (and withholds its units from everyone) until an operator re-affirms it.

terminatedstring[]

Reclaim only: spot VM ids terminated to free the reclaimed units.

topologyGeninteger

Node topology generation this reservation was written against

updatedAtstring
wouldSkipstring[]

Reclaim dry run only: VM ids that would be left running.

wouldTerminatestring[]

Reclaim dry run only: the spot VM ids this call would terminate.

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

    • 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

    • 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