Endpoints
Introduced in Dremio 2.0.0.
See Models for details on object representations.
Retrieve a job’s status
Retrieved the status of a job.
GET /api/v3/job/{id}
Output
{
JobStatus
}
Response Codes
403
- user does not have permission to access the specified job.
404
- a job with the specified id could not be found.
Retrieve results for a completed job
GET /api/v3/job/{id}/results?offset={offset}&limit={limit}
This endpoint supports pagination.
Set offset
to where you want to
start from (defaults to 0). limit
determines how many rows are returned -
defaults to 100 and can not be larger than 500.
Output
JobResults
Response Codes
400
- specified job is not in a completed state.
403
- user does not have permission to access the specified job.
404
- a job with the specified id could not be found.
Cancel a job
Note:
Introduced in Dremio 2.1.0
POST /api/v3/job/{id}/cancel
Cancels a running job.
Response Codes
400
- specified job is not in a running state.
403
- user does not have permission to access the specified job.
404
- a job with the specified id could not be found.