List Jobs

List all submitted jobs in the cluster and their details.

get/api/jobs

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/ray-project/apis/ray-jobs-api/docs/api/jobs/get.ts
A function with typed inputs. Its response is checked against the schema.

The details of the jobs.

type'SUBMISSION' | 'DRIVER' required

An enumeration for describing the different job types.

entrypointstring required

The entrypoint command for this job.

job_idstring nullable

The job id. An id that is created for every job that is launched in Ray. This id can be used to fetch data about jobs using Ray core APIs.

submission_idstring nullable

A submission id is an id created for every submission job. This id can be used to fetch data about jobs using the job submission APIs.

status'PENDING' | 'RUNNING' | 'STOPPED' | 'SUCCEEDED' | 'FAILED' required

An enumeration for describing the status of a job.

messagestring nullable

A message describing the status in more detail.

error_typestring nullable

Internal error, user script error

start_timeinteger nullable

The time when the job was started. A Unix timestamp in ms.

end_timeinteger nullable

The time when the job moved into a terminal state. A Unix timestamp in ms.

metadataobject nullable

Arbitrary user-provided metadata for the job.

runtime_envobject nullable

The runtime environment for the job.

driver_agent_http_addressstring nullable

Driver agent http address.

driver_node_idstring nullable

Driver node id.