Sign in

v1

latestOpenAPI 3.1.02026-07-178614.4 KB

Get Job Details

Get the status and details of a job.

get/api/jobs/{submission_id}

Path parameters

submission_idstring required

The ID of the job to get the status and details of.

Response

The details of the job.

type'SUBMISSION' | 'DRIVER' required

An enumeration for describing the different job types.

entrypointstring required

The entrypoint command for this job.

job_idstring

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

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

A message describing the status in more detail.

error_typestring

Internal error, user script error

start_timeinteger

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

end_timeinteger

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

metadataobject

Arbitrary user-provided metadata for the job.

runtime_envobject

The runtime environment for the job.

driver_agent_http_addressstring

Driver agent http address.

driver_node_idstring

Driver node id.