Fetch Job System State
GET/v1/dataset/jobs/status/:index_id
Gets the state of the job system for a particular atlas index.
Request
Path Parameters
index_id Index Idrequired
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
- MOD1
- MOD1
- MOD1
- MOD1
- MOD1
- MOD1
]
index_id Index Id (string)required
The atlas index id
status Status (string)required
The status of the index job : initiated, completed, failed
jobs
object[]
required
The progress of the index job
job_type Job Type (string)required
The type of job
state State (string)required
The job type state
creation_time date-timerequired
The job creation time
ready_time
object
The time the job became eligible to run
anyOf
string
start_time
object
required
The job start time
anyOf
string
end_time
object
The job end time
anyOf
string
worker_id
object
The UUID of the worker that last attempted the job
anyOf
string
attempt
object
of attempts made to run the job (0 if it has not been assigned)
anyOf
integer
priority
object
Job priority (higher runs first)
anyOf
integer
{
"index_id": "string",
"status": "string",
"jobs": [
{
"job_type": "string",
"state": "string",
"creation_time": "2024-07-29T15:51:28.071Z",
"ready_time": "2024-07-29T15:51:28.071Z",
"start_time": "2024-07-29T15:51:28.071Z",
"end_time": "2024-07-29T15:51:28.071Z",
"worker_id": "string",
"attempt": 0,
"priority": 0
}
]
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...