Skip to navigation
ReferenceAPI Gateway HTTP referenceHeimdall Service

Get a recovery sequence

View as Markdown
Read the canonical trace context for one exact scoped recovery operation. A missing sequence returns not found without creating state or authorizing scheduler actions.

Query parameters

schedulerSystemstringRequired
Scheduler system name, for example "slurm".
schedulerScopestringRequired
Deployment or cluster scope that disambiguates scheduler job identifiers.
jobIdstringRequired

Scheduler-specific job identifier.

sourceAttemptIndexintegerRequired

Zero-based attempt index on which recovery was triggered.

operationenumRequiredDefaults to RECOVERY_OPERATION_UNSPECIFIED

Scheduler-neutral recovery operation.

  • RECOVERY_OPERATION_UNSPECIFIED: No recovery operation was specified.
  • RECOVERY_OPERATION_RESTART: Restart the failed source attempt.
  • RECOVERY_OPERATION_TERMINATE: Terminate the source attempt.
  • RECOVERY_OPERATION_DAG_RELEASE: Release a held job after its DAG dependencies are satisfied.
Allowed values:

Response

A successful response.
recoveryContextobject
RecoveryContext carries one durable recovery sequence's W3C trace context. It is correlation data and does not authorize or otherwise change scheduler actions.