redocly logoAPI docs by Redocly

Ray Jobs API (4.0.0)

Download OpenAPI specification:Download

This is the specification for the Ray Jobs REST API. See the Ray Jobs documentation for details: https://docs.ray.io/en/latest/cluster/running-applications/job-submission/index.html

Get Version

Get the Ray Jobs API version and the Ray version running on the cluster.

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "ray_version": "string",
  • "ray_commit": "string"
}

Submit Job

Submit a job to the cluster.

Request Body schema: application/json
required

The job to submit.

entrypoint
required
string

Command to start execution, ex: 'python script.py'

submission_id
string

Optional submission_id to specify for the job.

job_id
string
Deprecated

Optional job_id to specify for the job.

runtime_env
object

The runtime environment for the job.

object

Arbitrary user-provided metadata for the job.

entrypoint_num_cpus
number

Number of CPUs to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

entrypoint_num_gpus
number

Number of GPUs to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

entrypoint_memory
integer

The quantity of memory to reserve for the execution of the entrypoint command, separately from any tasks or actors launched by it.

object

The quantity of various custom resources to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

Responses

Request samples

Content type
application/json
{
  • "entrypoint": "string",
  • "submission_id": "string",
  • "job_id": "string",
  • "runtime_env": { },
  • "metadata": {
    },
  • "entrypoint_num_cpus": 0,
  • "entrypoint_num_gpus": 0,
  • "entrypoint_memory": 0,
  • "entrypoint_resources": {
    }
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "submission_id": "string"
}

List Jobs

List all submitted jobs in the cluster and their details.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Job Details

Get the status and details of a job.

path Parameters
submission_id
required
string

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

Responses

Response samples

Content type
application/json
{
  • "type": "SUBMISSION",
  • "entrypoint": "string",
  • "job_id": "string",
  • "submission_id": "string",
  • "driver_info": {
    },
  • "status": "PENDING",
  • "message": "string",
  • "error_type": "string",
  • "start_time": 0,
  • "end_time": 0,
  • "metadata": {
    },
  • "runtime_env": { },
  • "driver_agent_http_address": "string",
  • "driver_node_id": "string"
}

Delete Job

Delete a job that is already in a terminal state.

path Parameters
submission_id
required
string

The ID of the job to cancel.

Responses

Response samples

Content type
application/json
true

Stop Job

Stop a job.

path Parameters
submission_id
required
string

The ID of the job to stop.

Responses

Response samples

Content type
application/json
"PENDING"

Get Job Logs

Get the logs of a job.

path Parameters
submission_id
required
string

The ID of the job to get the logs of.

Responses

Response samples

Content type
application/json
{
  • "logs": "string"
}

Tail Job Logs

WebSocket endpoint for tailing the logs of a job (Not documented in OpenAPI, see https://docs.ray.io/en/latest/_modules/ray/dashboard/modules/job/sdk.html#JobSubmissionClient.tail_job_logs for example usage).

path Parameters
submission_id
required
string

The ID of the job to tail the logs of.

Responses