Batches API v1Alpha

Get a job in a batch

Changed on

Get a job in a batch by ID.

get/api/v1alpha/batches/{batch_id}/jobs/{job_id}

Request

  • Base URL: {{ base_url }}
  • URL: {{ base_url }}/api/v1alpha/batches/{batch_id}/jobs/{job_id}
  • Auth: none declared

Path parameters

batch_idnumber required

The ID of the batch.

job_idnumber required

The ID of the job.

Response

Successfully retrieved the job in the batch.

batch_idinteger

ID of the batch this job belongs to

job_idinteger

The job ID

job_group_idinteger

ID of the job group this job belongs to

namestring nullable

Name of the job

userstring

User who owns the job

billing_projectstring

Billing project for the job

state'Pending' | 'Ready' | 'Creating' | 'Running' | 'Failed' | 'Cancelled' | 'Error' | 'Success'

Current state of the job

display_statestring nullable

Human-readable display state

exit_codeinteger nullable

Exit code of the job

durationnumber nullable

Duration of the job in milliseconds

start_timestring date-time nullable

When the job started

end_timestring date-time nullable

When the job ended

costnumber nullable

Total cost of the job in USD

msec_mcpuinteger

Millisecond milli-CPU usage

always_runboolean

Whether the job runs regardless of the batch's success state

n_max_attemptsinteger

Maximum number of times this job will be attempted

inst_collstring nullable

Instance collection the job ran on

attributesobject nullable

Key-value pairs of attributes for the job

statusobject nullable

Detailed job status

Changes

    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      the response property became nullable for the status

    • warning

      added the new Cancelled enum value to the response property for the response status

    • warning

      added the new Creating enum value to the response property for the response status

    • warning

      added the new Error enum value to the response property for the response status

    • warning

      added the new Failed enum value to the response property for the response status

    • warning

      added the new Pending enum value to the response property for the response status

    • warning

      added the new Ready enum value to the response property for the response status

    • warning

      added the new Running enum value to the response property for the response status

    • warning

      added the new Success enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the cancelled enum value from the response property for the response status

    • info

      removed the failed enum value from the response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the running enum value from the response property for the response status

    • info

      removed the succeeded enum value from the response property for the response status