GET jobs
Returns a list of jobs being tracked by the agent and job details.
Jobs always start immediately. The is_running
field is a Boolean value. If is_running
is false, then the job is complete.
The exit_code
details the status of the job. The exit_code
is different for certain types of jobs:
-
For Backup jobs:
- 0 indicates success.
- Any other number indicates a failure.
-
For all other jobs:
- -9 indicates success.
- Any other number indicates a failure.
You can see details about failures in /opt/vertica/log/agentStdMsg.log
.
Resource URL
https://<NODE>:5444/jobs
Authentication
Requires a VerticaAPIKey in the request header.
The API key must have restricted level security or higher.
Parameters
None.
Example Request
GET |
https://<NODE>:5444/jobs |
Response:
{ "body": [ { "exit_code": 0, "id": "CreateBackup-VMart-1405012447.75", "is_running": false, "status": "unused", "ts": "1405012461.18" }, { "exit_code": 1, "id": "CreateBackup-VMart-1405012454.88", "is_running": false, "status": "unused", "ts": "1405012455.18" } ], "href": "/jobs", "links": [ "/:jobid" ], "mime-type": "application/vertica.jobs.json-v2" }