Introduction to JobServer

JobServer is a flexible and powerful system designed to handle various job scheduling and processing tasks. It offers dozens of useful APIs to interact seamlessly with its job processing capabilities. Below, we provide an in-depth guide to JobServer along with code snippets showcasing how to use its APIs effectively in your application.

API Examples

Create a Job

  POST /jobs
  {
    "name": "data_import",
    "schedule": "0 0 * * *",
    "command": "/usr/bin/python3 /scripts/import_data.py"
  }

Retrieve Job Details

  GET /jobs/{job_id}

Update a Job

  PUT /jobs/{job_id}
  {
    "name": "data_import",
    "schedule": "0 6 * * *",       // Change the schedule to 6 AM daily
    "command": "/usr/bin/python3 /scripts/import_data.py"
  }

Delete a Job

  DELETE /jobs/{job_id}

List All Jobs

  GET /jobs

Execute a Job Manually

  POST /jobs/{job_id}/execute

Check Job Status

  GET /jobs/{job_id}/status

Retrieve Job Logs

  GET /jobs/{job_id}/logs

Create a Job Template

  POST /templates
  {
    "name": "backup_template",
    "command": "/usr/bin/python3 /scripts/backup.py"
  }

Use a Job Template

  POST /jobs
  {
    "name": "backup_nightly",
    "schedule": "0 0 * * *",
    "template_id": "{template_id}"
  }

Integrating JobServer in Your App

In this section, we’ll see an example of how to integrate JobServer’s APIs into a simple application.

A Simple Example Application

  import requests

  BASE_URL = 'http://jobserver.local/api'

  def create_job():
      url = f'{BASE_URL}/jobs'
      payload = {
          "name": "daily_cleanup",
          "schedule": "0 3 * * *",
          "command": "/usr/bin/python3 /scripts/cleanup.py"
      }
      response = requests.post(url, json=payload)
      return response.json()

  def get_job(job_id):
      url = f'{BASE_URL}/jobs/{job_id}'
      response = requests.get(url)
      return response.json()

  def main():
      job = create_job()
      print(f'Created Job: {job}')

      job_details = get_job(job['id'])
      print(f'Job Details: {job_details}')

  if __name__ == '__main__':
      main()

Conclusion

JobServer provides a robust set of APIs to manage job scheduling and processing. By integrating these APIs into your applications, you can automate and streamline numerous tasks, enhancing productivity and efficiency.

Hash: ab0f4d745358c4ed1c2d577a4632fe71843dce3e23755b089e528891dcdc2360