Sign in
Locks

Read a project lock

Changed on

Reports whether the lock is currently held, when its lease expires, and the holder's fencing token. held follows takeover eligibility rather than raw expiry, so held: false means an acquire would succeed now. No lock token is required, making this usable for monitoring and recovery.

get/locks/{key}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/locks/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

Project-local lock name.

Headers

X-Volcano-Request-Idstring uuid required

UUID correlating this request across client and server logs. Repeat safety comes from the lock token, so a retry under a reused request ID still counts against the quota.

Response

Current lock state

heldboolean required

Whether the lock is unavailable right now. False means an acquire would succeed. It remains true during the brief grace window after expiry.

expires_atstring date-time

Advisory lease expiry timestamp in UTC. Present only when held.

fencing_tokeninteger

Current holder's fencing token. Present only when held.

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • bb44e98aba2eRevision changes
    • ○

      endpoint added