Get VM Jobs

Select

SaaS

Customer Managed

Get VM Jobs

Path Parameters

• vmGuid string required

Query Parameters

• completedJobLookupTime int32
• jobTypeList string
• statusList string
• showAgedJobs boolean
• backupLevel string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Get V M Jobs

---

Schema

• totalRecordsWithoutPaging integer
• jobs object[]

  jobSummary object

  sizeOfApplication integer

  vsaParentJobID integer

  backupSetName string

  opType integer

  totalFailedFolders integer

  totalFailedFiles integer

  alertColorLevel integer

  isVisible boolean

  localizedStatus string

  isAged boolean

  totalNumOfFiles integer

  jobId integer

  jobSubmitErrorCode integer

  sizeOfMediaOnDisk integer

  status string

  lastUpdateTime integer

  percentSavings integer

  localizedOperationName string

  statusColor string

  pendingReason string

  errorType integer

  backupLevel integer

  jobElapsedTime integer

  jobStartTime integer

  currentPhaseName string

  jobType string

  isPreemptable integer

  backupLevelName string

  pendingReasonErrorCode string

  appTypeName string

  percentComplete integer

  localizedBackupLevelName string

  subclientName string

  destClientName string

  jobEndTime integer

  subclient object

  clientName string

  instanceName string

  backupsetId integer

  commCellName string

  instanceId integer

  subclientId integer

  clientId integer

  appName string

  backupsetName string

  applicationId integer

  subclientName string

  destinationClient object

  clientId integer

  clientName string

  displayName string

  userName object

  userName string

  userId integer

{
  "totalRecordsWithoutPaging": 0,
  "jobs": [
    {
      "jobSummary": {
        "sizeOfApplication": 0,
        "vsaParentJobID": 0,
        "backupSetName": "string",
        "opType": 0,
        "totalFailedFolders": 0,
        "totalFailedFiles": 0,
        "alertColorLevel": 0,
        "isVisible": true,
        "localizedStatus": "string",
        "isAged": true,
        "totalNumOfFiles": 0,
        "jobId": 0,
        "jobSubmitErrorCode": 0,
        "sizeOfMediaOnDisk": 0,
        "status": "string",
        "lastUpdateTime": 0,
        "percentSavings": 0,
        "localizedOperationName": "string",
        "statusColor": "string",
        "pendingReason": "string",
        "errorType": 0,
        "backupLevel": 0,
        "jobElapsedTime": 0,
        "jobStartTime": 0,
        "currentPhaseName": "string",
        "jobType": "string",
        "isPreemptable": 0,
        "backupLevelName": "string",
        "pendingReasonErrorCode": "string",
        "appTypeName": "string",
        "percentComplete": 0,
        "localizedBackupLevelName": "string",
        "subclientName": "string",
        "destClientName": "string",
        "jobEndTime": 0,
        "subclient": {
          "clientName": "string",
          "instanceName": "string",
          "backupsetId": 0,
          "commCellName": "string",
          "instanceId": 0,
          "subclientId": 0,
          "clientId": 0,
          "appName": "string",
          "backupsetName": "string",
          "applicationId": 0,
          "subclientName": "string"
        },
        "destinationClient": {
          "clientId": 0,
          "clientName": "string",
          "displayName": "string"
        },
        "userName": {
          "userName": "string",
          "userId": 0
        }
      }
    }
  ]
}

{
  "totalRecordsWithoutPaging": 1,
  "jobs": [
    {
      "jobSummary": {
        "sizeOfApplication": 15982413873,
        "vsaParentJobID": 0,
        "backupSetName": "defaultBackupSet",
        "opType": 4,
        "totalFailedFolders": 0,
        "totalFailedFiles": 0,
        "alertColorLevel": 0,
        "isVisible": true,
        "localizedStatus": "Completed",
        "isAged": false,
        "totalNumOfFiles": 15263,
        "jobId": 121308,
        "jobSubmitErrorCode": 0,
        "sizeOfMediaOnDisk": 0,
        "status": "Completed",
        "lastUpdateTime": 1545293732,
        "percentSavings": 0,
        "localizedOperationName": "Backup",
        "statusColor": "black",
        "pendingReason": "",
        "errorType": 0,
        "backupLevel": 1,
        "jobElapsedTime": 333,
        "jobStartTime": 1545293383,
        "currentPhaseName": "",
        "jobType": "Backup",
        "isPreemptable": 0,
        "backupLevelName": "Full",
        "pendingReasonErrorCode": "",
        "appTypeName": "Virtual Server",
        "percentComplete": 100,
        "localizedBackupLevelName": "Full",
        "subclientName": "default",
        "destClientName": "RestAPI",
        "jobEndTime": 1545293732,
        "subclient": {
          "clientName": "RestApiBackupVM",
          "instanceName": "VMware",
          "backupsetId": 537,
          "commCellName": "VSAAUTOCS",
          "instanceId": 118,
          "subclientId": 1013,
          "clientId": 3650,
          "appName": "Virtual Server",
          "backupsetName": "defaultBackupSet",
          "applicationId": 106,
          "subclientName": "default"
        },
        "destinationClient": {
          "clientId": 2412,
          "clientName": "RestAPI",
          "displayName": ""
        },
        "userName": {
          "userName": "testadmin",
          "userId": 9
        }
      }
    }
  ]
}

GET /v2/vsa/vm/:vmguid/jobs    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

vmGuid — path required

completedJobLookupTime — query

jobTypeList — query

statusList — query

showAgedJobs — query

---truefalse

backupLevel — query

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/v2/vsa/vm/:vmGuid/Jobs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'