List jobs | NVIDIA Recovery

{
  "jobs": [
    {
      "workflowId": "string",
      "heimdallJobId": "string",
      "jobRunId": "string",
      "jobId": "string",
      "attemptIndex": 1,
      "nodes": [
        "string"
      ],
      "gpuCountPerNode": 1,
      "nodeConstraints": {
        "exclusions": [
          "string"
        ],
        "inclusions": [
          "string"
        ]
      },
      "additionalProperties": {
        "maxRequeueTimes": 1,
        "enableNvrx": true
      },
      "state": "JOB_STATUS_UNSPECIFIED",
      "createdAt": "2024-01-15T09:30:00Z",
      "lastSeen": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "jobName": "string",
      "schedulerMetadata": {},
      "recoveryConfig": {
        "autoResumeMode": "AUTO_RESUME_MODE_UNSPECIFIED",
        "maxRequeueTimes": 1,
        "requeueOnCompletion": true,
        "anomalyDetectionConfig": {
          "logBasedCrashEnabled": true,
          "logBasedTimeoutEnabled": true,
          "logBasedTimeoutThresholdPretraining": 1,
          "logBasedTimeoutThresholdTrainingloop": 1
        },
        "dagDependencies": [
          {
            "jobId": "string",
            "jobName": "string",
            "trigger": "TRIGGER_CONDITION_UNSPECIFIED"
          }
        ],
        "dagAction": "DAG_ACTION_UNSPECIFIED",
        "environment": "string",
        "logFilePathsSharedAcrossAttempts": true
      }
    }
  ],
  "count": 1,
  "nextPageToken": "string"
}

Retrieve a list of jobs that the Advisor is aware of. Jobs are ordered by creation time ascending for synchronization purposes. Use the page parameter to get the next page of jobs.

Query parameters

pageTokenstringOptional

A decimal zero-based offset from the previous response’s next_page_token field. Mutually exclusive with page_number.

pageNumberintegerOptional

A one-based page number. Page N starts at offset (N - 1) * limit. Mutually exclusive with page_token.

limitintegerOptional

The maximum number of jobs to return. Defaults to 100 and cannot exceed 250.

workflowIdslist of stringsOptional

The workflow IDs to filter by.

jobIdslist of stringsOptional

The job IDs to filter by.

jmStatestringOptional

Job manager / scheduler state filter (e.g. RUNNING, COMPLETED). Passed through to job manager.

reconciliationEligibleJobsbooleanOptional

Return jobs that can seed scheduler reconciliation: all non-final jobs plus failure-like terminal jobs. COMPLETED and REQUEUED jobs are excluded because their recovery is driven by exact-attempt Advice. Passed through to job manager and mutually exclusive with jm_state.

completedJobsbooleanOptional

Filter by backend completion state: false returns non-final attempts, true returns final attempts, and omission preserves historical listing. Passed through to job manager; mutually exclusive with jm_state and reconciliation_eligible_jobs=true.

endTimeFromdatetimeOptional

Inclusive lower bound on persisted job end time, applied in job manager before count and pagination. Attempts without an end time are excluded.

Response

A successful response.

jobslist of objectsOptional

The list of jobs.

countintegerOptional

The total count of jobs returned.

nextPageTokenstringOptional

The decimal zero-based offset to use for the next page of results.