Get backup job status

Overview

Get backup job status.

Classification

  • jobs

API Operation Object

  • Backup Job

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/{project_id}/jobs/backup

HTTP Request Header

Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

This operation does not send a request body.

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
project_id URL UUID(3) Project id required - Terminate 400
token_id Header authentication token string keystone authentication token required - Terminate 401
client_name Query String Client name. required - Terminate 400, 404
job_id Query int The job ID for the job. Prefferd above any other options. optional - Terminate 400,404
from Query time/date Start date to find the backup job. Required with ‘to’ in the query to enable this parameter. ‘YYYYMMDD’ format in UTC timezone. Answer Top 30 records per a request. If this parameter and job_id was empty, latest 1 week will be applied as the default value. Maximum 31days available. optional Latest 1week Terminate 400
to Query time/date End date to find the backup job. Required with ‘from’ in the query to enable this parameter. ‘YYYYMMDD’ format in UTC timezone. Answer Top 30 records per a request. If this parameter and job_id was empty, latest 1 week will be applied as the default value. Maximum 31days available. optional Latest 1week Terminate 400

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 normal end
400 Bad request
401 Unauthorized
404 Not Found.
500 Response Code

Response Body

Format

{
  "jobs": [
    {
      "JobID": "<JobID>",
      "ClientName": "<ClientName>",
      "ClientType": "<ClientType>",
      "SystemState": "<SystemState>",
      "Trigger": "<Trigger>",
      "BackupType": "<BackupType>",
      "JobStatus": "<JobStatus>",
      "FailureReason": "<FailureReason>",
      "NumOfFiles": "<NumOfFiles>",
      "Size": "<Size>",
      "Start": "<Start>",
      "End": "<End>",
      "Duration": "<Duration>"
    }
  ]
}

Response Parameter

Response Parameters
item format description
JobID int System-generated ID assigned to the job.
ClientName String Client name
ClientType String Client Platform
SystemState true/false System state backup option.
Trigger String Trigger of backup. Schedule backup or on-demand backup.
BackupType String Full backup or Incremental backup.
JobStatus String Status of the job.
FailureReason String Failure Reason.
NumOfFiles int Number of files backed up.
Size float Backup data size.(GigaByte)
Start time/date Date and time the job started.
End time/date Date and time the job finished.
Duration time Duration of time for the job.

Sample Request and Response

Sample API Request

Request URL

https://example.com/v1.0/{project_id}/jobs/backup?client_name={client_name}&from=20170101&to=20170110

Request Header

Accept: application/json
X-Auth-Token: ajk3adjiown02

Request Body

This operation does not send a request body.

Sample API Response

Response Header

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Body

{
  "jobs": [
    {
      "JobID": "<JobID>",
      "ClientName": "<ClientName>",
      "ClientType": "<ClientType>",
      "SystemState": "<SystemState>",
      "Trigger": "<Trigger>",
      "BackupType": "<BackupType>",
      "JobStatus": "<JobStatus>",
      "FailureReason": "<FailureReason>",
      "NumOfFiles": "<NumOfFiles>",
      "Size": "<Size>",
      "Start": "<Start>",
      "End": "<End>",
      "Duration": "<Duration>"
    }
  ]
}

Execution Example

HTTP Request

GET /v1.0/b322a85578de48beba0f92acce57869b/jobs/backup?client_name=A000001_Backup_Client1&from=20170101&to=20170110 HTTP/1.1
User-Agent: curl/7.35.0
Host: backup_api_endpoint
Accept: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 364
Date: Thu, 17 Jul 2014 04:21:06 GMT

{
  "jobs": [
    {
      "JobID": "22994",
      "ClientName": "A000001_Backup_Client1",
      "ClientType": "Linux File System",
      "SystemState": "false",
      "Trigger": "Gui",
      "BackupType": "Incremental",
      "JobStatus": "Success",
      "FailureReason": "",
      "NumOfFiles": "29",
      "Size": "0.02",
      "Start": "2017/03/02 11:19:50",
      "End": "2017/03/02 11:21:09",
      "Duration": "0h 1m 19s"
    },
    {
      "JobID": "22992",
      "ClientName": "A000001_Backup_Client1",
      "ClientType": "Linux File System",
      "SystemState": "false",
      "Trigger": "Gui",
      "BackupType": "Incremental",
      "JobStatus": "Success",
      "FailureReason": "",
      "NumOfFiles": "29",
      "Size": "0.02",
      "Start": "2017/03/02 10:59:57",
      "End": "2017/03/02 11:01:22",
      "Duration": "0h 1m 25s"
    }
  ]
}