Get Job Info
Product version: 10.11
Last modified: 31 July 2024
Returns detailed job info.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
curl --request POST \
--url https://<Director_IP_address>:4443/c/router \
--header "content-type: application/json" \
--cookie @cookies.txt \
--data '{
"action": "JobSummaryManagement",
"method": "getJobInfo",
"data": [[1],0],
"type": "rpc",
"tid": 1}'
Request Fields
Field
|
Type
|
Value(s)
|
---|---|---|
action
|
string |
|
method
|
string |
|
data
|
array of int
|
Parameters |
type
|
string |
|
tid
|
integer |
|
Data
Field
|
Type
|
Description
|
---|---|---|
idList
|
array of int
|
Job IDs |
clientTimeOffsetToUtc
|
int | Client's current timezone offset to UTC |
Response Sample
{
"action": "JobSummaryManagement",
"method": "getJobInfo",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"children": [
{
"name": "Backup job for VMware",
"id": 3,
"vid": "JOB-3",
"hvType": "VMWARE",
"hvTypeBackupCount": {
"VMWARE": 1
},
"hvTypeBackupHasRootDiskCount": {
},
"status": "GREEN",
"jobType": "BACKUP",
"added": "2024-05-09T15:54:54.092+07:00",
"updated": "2024-05-09T15:54:54.092+07:00",
"vmCount": 1,
"vmTemplateCount": 0,
"diskCount": 1,
"jobSameTypeCount": 3,
"sourcesSize": 32768,
"sourcesAllocatedSize": 32768,
"isEnabled": true,
"isLicensed": true,
"isEdited": false,
"isLocked": false,
"isLockedRunningJob": false,
"isRemoved": false,
"fromBackup": false,
"reachedTerminalLimitState": false,
"averageDurationMs": 18590,
"averageDurationSampleCount": 1,
"crState": "WAITING_SCHEDULE",
"crDate": null,
"crDateRelative": 0,
"crVmPlanned": 0,
"crVmOk": 0,
"crVmFailed": 0,
"crVmSkipped": 0,
"crVmStopped": 0,
"crProgress": 0,
"crTotalProcessedItem": 0,
"crTotalNewProcessedItem": 0,
"crAdhoc": false,
"crSiteRecoveryRunType": null,
"crRecoveryTimeObjectiveType": null,
"crRecoveryTimeObjective": null,
"crFailoverType": null,
"hasLastRun": true,
"lrState": "OK",
"lrDate": "2024-05-09T16:51:01.563+07:00",
"lrFinishDate": "2024-05-09T16:51:20.153+07:00",
"lrSpeed": 0,
"lrDurationMs": 18590,
"lrDataKb": 0,
"lrVmOk": 1,
"lrVmFailed": 0,
"lrVmSkipped": 0,
"lrVmStopped": 0,
"lrAdhoc": false,
"lrCompressionRatio": 0,
"lrSiteRecoveryRunType": null,
"lrRecoveryTimeObjectiveType": null,
"lrRecoveryTimeObjective": null,
"lrFailoverType": null,
"lrActionFailed": 0,
"lrActionSkipped": 0,
"lrActionSucceed": 0,
"lrActionStopped": 0,
"lrJobPriority": 5,
"lrSkippedItems": null,
"differentialTrackingMode": "NONE",
"preScriptExecutionMode": "NEVER",
"preScriptBehavior": "NONE",
"preScriptErrorMode": "NONE",
"preScriptPath": null,
"postScriptExecutionMode": "NEVER",
"postScriptBehavior": "NONE",
"postScriptErrorMode": "NONE",
"postScriptPath": null,
"thinDiskMode": "AUTO",
"ebsVolumeMode": "AUTO",
"temporaryVolumeType": "MAGNETIC",
"networkAccelerationMode": "NONE",
"encryptionMode": "NONE",
"applicationAwareMode": "NONE",
"applicationAwareAgentMode": null,
"retentionPolicy": null,
"powerVmsOn": false,
"generateMac": false,
"recoveryType": null,
"powerSourceVmsOff": false,
"sendReports": false,
"transporterMode": "AUTO",
"targetLocationType": null,
"exchangeLogTruncationMode": "NONE",
"sqlLogTruncationMode": "NONE",
"vmVerificationType": "NONE",
"fullBackupRunSettingsType": "ALWAYS",
"fullBackupMode": "ACTIVE",
"runFullOnPreFullFailed": null,
"recoveryTimeObjectiveType": null,
"recoveryTimeObjective": null,
"tapeAppending": null,
"targetStorageType": "DISK",
"objects": [
{
"vid": "JOB_OBJECT-6",
"lrStepVid": "JOB_EXECUTION_STEP-18",
"lrState": "SUCCEEDED",
"lrSpeed": 0,
"lrDataTransferredUncompressed": 0,
"lrDuration": 10,
"lrTotalDuration": 17490,
"lrBackupType": "FULL",
"lrBandwidthLimit": 0,
"lrTransporterModes": [
"LAN"
],
"lrLogicalSteps": [
{
"id": 131,
"step": "INIT",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:02.569+07:00",
"finished": "2024-05-09T16:51:04.083+07:00",
"duration": 1514,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": "2024-05-09T16:51:02.570+07:00",
"finishedJobExecutionStep": "2024-05-09T16:51:20.044+07:00",
"stateJobExecutionStep": "SUCCEEDED",
"durationJobExecutionStep": 17474
},
{
"id": 132,
"step": "WAIT_FOR_TRANSPORTER",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:04.087+07:00",
"finished": "2024-05-09T16:51:04.204+07:00",
"duration": 117,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 133,
"step": "BANDWIDTH_ALLOCATION",
"state": "SKIPPED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:04.205+07:00",
"finished": "2024-05-09T16:51:04.208+07:00",
"duration": 3,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 134,
"step": "REMOVING_OLD_SNAPSHOTS",
"state": "SKIPPED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:04.210+07:00",
"finished": "2024-05-09T16:51:04.215+07:00",
"duration": 5,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 135,
"step": "DATA_TRANSFER",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:04.217+07:00",
"finished": "2024-05-09T16:51:20.024+07:00",
"duration": 15807,
"runCount": 1,
"processedProgress": 7751,
"maxProgress": 7751,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 136,
"step": "EXCHANGE_LOGS_TRUNCATION",
"state": "SKIPPED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:20.026+07:00",
"finished": "2024-05-09T16:51:20.028+07:00",
"duration": 2,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 137,
"step": "SQL_SERVER_LOGS_TRUNCATION",
"state": "SKIPPED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:20.030+07:00",
"finished": "2024-05-09T16:51:20.032+07:00",
"duration": 2,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 138,
"step": "APPLY_RETENTION_POLICY",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": "2024-05-09T16:51:20.035+07:00",
"finished": "2024-05-09T16:51:20.037+07:00",
"duration": 2,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 139,
"step": "VM_VERIFICATION",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": null,
"finished": "2024-05-09T16:51:20.077+07:00",
"duration": null,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
},
{
"id": 140,
"step": "COMPLETE",
"state": "SUCCEEDED",
"processedItem": 0,
"newProcessedItem": 0,
"started": null,
"finished": "2024-05-09T16:51:20.077+07:00",
"duration": null,
"runCount": 1,
"processedProgress": null,
"maxProgress": null,
"startedJobExecutionStep": null,
"finishedJobExecutionStep": null,
"stateJobExecutionStep": null,
"durationJobExecutionStep": null
}
],
"crState": "SCHEDULED",
"crProgress": 10000,
"crTransporterModes": null,
"crProcessedItem": 0,
"crNewProcessedItem": 0,
"crLogicalSteps": null,
"backupMethodMode": "NORMAL",
"crActionName": null,
"includedInJobRun": false,
"crSpeed": 0,
"crDataTransferredUncompressed": 0,
"crDuration": 0,
"crTotalDuration": 0,
"crBandwidthLimit": 0,
"sourceVid": "VM-36",
"sourceName": "@a",
"sourcePowerState": "OFF",
"sourceSubType": "VM",
"sourceType": null,
"targetVid": "BACKUP_OBJECT-6",
"targetName": "@a",
"targetPowerState": "UNKNOWN",
"targetSubType": null,
"verificationState": null,
"screenshotName": null,
"screenshotPath": null,
"flashBootState": "WAITING",
"waitingReason": null,
"waitingFor": null,
"waitingForVid": null,
"remainWaitingTime": null,
"hasCompletedSavepoint": false,
"lastFullFailed": false,
"crRpoValue": 0,
"rpoType": null,
"jobExecutionStepState": null
}
],
"transporters": [
{
"isAuto": true,
"usedAsSource": false,
"usedAsTarget": false,
"usedAsProxy": false,
"maxLoadFactor": 0,
"currentTotalLoad": 0,
"vid": null,
"name": null,
"state": null
},
{
"isAuto": false,
"usedAsSource": false,
"usedAsTarget": true,
"usedAsProxy": false,
"maxLoadFactor": 6,
"currentTotalLoad": 0,
"vid": "TRANSPORTER-1",
"name": "Onboard transporter",
"state": "OK"
}
],
"storages": [
{
"vid": "BACKUP_REPOSITORY-1",
"name": "Onboard repository",
"size": 21275807744,
"free": 12417695744,
"used": 144880898,
"state": "OK",
"online": true,
"infiniteSize": false,
"type": "INCREMENTAL_WITH_FULL_BACKUPS",
"location": "LOCAL"
}
],
"actions": [],
"crActionExecutions": null,
"lrActionExecutions": null,
"scheduleRetention": true,
"useBackupEncryption": false,
"isChangedEncryption": false,
"schedules": [
{
"id": 4,
"uuid": null,
"name": null,
"enabled": true,
"type": null,
"monthlyEveryType": "SECOND",
"everyType": "MINUTE",
"every": 1,
"startTime": "04:51:00 PM",
"endTime": null,
"dayOfWeek": 4,
"dayOfMonth": 1,
"month": 0,
"timezone": "Asia/Bangkok",
"on": 31,
"triggerItem": null,
"triggerItemSchedule": null,
"triggerRunType": null,
"triggerEvents": null,
"nextRun": "2024-06-13T16:51:00.000+07:00",
"referenceTime": null,
"effectiveDate": null,
"position": 1,
"triggerItemName": null,
"triggerItemTypeName": null,
"timezoneOffsetMs": 25200000,
"nextRunRelative": 3023968727,
"scheduleRetentionType": "MONTHLY",
"customKeepSavepointCount": 6,
"customKeepSavepointType": "MONTHS",
"keepImmutableSavepointCount": null,
"copyOneLatestOnly": null
},
{
"id": 5,
"uuid": null,
"name": "",
"enabled": true,
"type": null,
"monthlyEveryType": "LAST",
"everyType": "MINUTE",
"every": 1,
"startTime": "04:51:00 PM",
"endTime": null,
"dayOfWeek": 5,
"dayOfMonth": 1,
"month": 0,
"timezone": "Asia/Bangkok",
"on": 31,
"triggerItem": null,
"triggerItemSchedule": null,
"triggerRunType": null,
"triggerEvents": null,
"nextRun": "2024-05-10T16:51:00.000+07:00",
"referenceTime": null,
"effectiveDate": null,
"position": 2,
"triggerItemName": null,
"triggerItemTypeName": null,
"timezoneOffsetMs": 25200000,
"nextRunRelative": 86368727,
"scheduleRetentionType": "WEEKLY",
"customKeepSavepointCount": 10,
"customKeepSavepointType": "DAYS",
"keepImmutableSavepointCount": null,
"copyOneLatestOnly": false
}
],
"lockReasons": []
}
],
"totalCount": 1
}
}
Response Fields
Field
|
Value
|
Description
|
---|---|---|
message
|
string | Message if the request failed |
where
|
string | Reference to the method where problem occurred |
cause
|
string | Cause of failure |
data
|
array | Job parameters |
data.children
Field |
Type |
Description |
|
string |
Display name |
|
int |
Job ID |
|
string |
Job VID |
|
string |
Platform type |
|
Json |
Number of machines by platform |
|
boolean |
Special case for a replication job: |
|
string |
Site recovery specific: the type of recovery running for the last job run. Possible values: |
|
string |
Site recovery specific: the type of recovery time objective for the last job run. Possible values: |
|
int |
Site recovery specific: the recovery time objective for the last job run |
|
string |
Site recovery specific: the failover type for the last job run. Possible values: |
|
int |
Site recovery specific: action failed for the last job run |
|
int |
Site recovery specific: action skipped for the last job run |
|
int |
Site recovery specific: action succeeded for the last job run |
|
int |
Site recovery specific: action stopped for the last job run |
|
string |
Path to the post-script |
|
boolean |
|
|
string |
Truncation mode of Microsoft SQL Server logging. Possible values: |
|
string |
Type of full backup job run settings. Possible values: |
|
string |
Full backup mode. Possible values: |
|
string |
Type of recovery time objective. Possible values: |
|
int |
Recovery time objective |
|
string |
Specific for site recovery job: the type of site recovery running for the current job run. Possible values: |
|
string |
Specific for site recovery job: the type of recovery time objective for the current job run. Possible values: |
|
int |
Specific for site recovery job: the recovery time objective for the current job run |
|
string |
Specific for site recovery job: the failover type for the current job run. Possible values: |
|
array |
List of actions |
|
array |
List of actions for the current job run |
|
array |
List of action for the last job run |
|
Json |
AWS-specific: backup count which savepoints have a Root volume |
|
string |
Job status |
|
string |
Job type. Possible values: |
|
string |
Date added |
|
string |
Date updated |
|
int |
The number of machines |
|
int |
The number of disks |
|
|
The total size of source machines |
|
boolean |
Checks if the job is enabled |
|
boolean |
Checks if the job does not violate license |
|
boolean |
Checks if the job was edited |
|
boolean |
Checks if the job was locked |
|
boolean |
Checks if the job was removed |
|
|
The average job duration (in ms) |
|
int |
The number of job runs to calculate average job duration |
|
string |
Current state. Possible values: |
|
string |
Timestamp of the current job run |
|
long |
Relative timestamp (time passed from the job start run) of the current job run |
|
int |
The number of machines queued for processing for the current job run |
|
int |
The number of successfully processed machines during the current job run |
|
int |
The number of failed machines during the current job run |
|
int |
The number of machines stopped during the current job run |
|
int |
Current job run progress |
|
boolean |
|
|
boolean |
Checks if the job had a last run |
|
string |
The state of the last job run. Possible values: |
|
string |
The date and time of the last job run start |
|
string |
The date and time of the last job run end |
|
|
The speed of the last job run |
|
|
The duration of the last job run |
|
|
Data transferred during the last job run |
|
int |
Number of successfully processed machines during the last job run |
|
int |
Number of machines failed during the last job run |
|
int |
Number of machines stopped during the last job run |
|
boolean |
|
|
int |
The compression ratio during the last job run |
|
string |
A method used for forever-incremental backup. Possible values: |
|
string |
The mode of execution of pre-job scripts. Possible values: |
|
string |
Job behavior: either to wait for the script to finish or proceed. Possible values: |
|
string |
The job behavior on pre-job script failure. Possible values: |
|
string |
The path to the pre-job script |
|
string |
The mode of execution of post-job scripts. Possible values: |
|
string |
Job behavior: either to wait for the script to finish or proceed. Possible values: |
|
string |
The job behavior on post-job script failure. Possible values: |
|
string |
For replication: thin disk or respect source. Possible values: |
|
string |
For AWS jobs only: a type of EBS volume. Possible values: |
|
string |
For AWS jobs only: a type of a temporary volume |
|
string |
Network acceleration mode. Possible values: |
|
string |
Encryption mode. Possible values: |
|
string |
Application-aware mode. Possible values: |
|
Json |
Retention policy options. See below |
|
boolean |
Recovery only. Defines if the recovered machines must be powered on after the job is completed |
|
boolean |
Recovery only. Defines if a new MAC-address should be generated for the recovered machine |
|
string |
Recovery type. Possible values: |
|
string |
The mode of data transfer. Possible values: |
|
string |
Mode of Microsoft Exchange log truncation. Possible values: |
|
string |
The mode of screenshot verification. Possible values: |
|
array |
Source objects |
|
array |
Transporters used |
|
array |
Storages |
|
array |
Job schedules |
|
array |
If the job is locked, lock reasons |
retentionPolicy
Field |
Value |
Description |
|
|
string |
Retention mode. The |
|
|
int |
Maximum number of recovery points |
|
|
int |
Maximum number of days to keep a recovery point |
|
|
int |
Maximum number of weeks to keep a recovery point |
|
|
int |
Maximum number of months to keep a recovery point |
|
|
int |
Maximum number of years to keep a recovery point |
|
objects
Source job objects
Field |
Values |
Description |
|
string |
VID of a job object |
|
string |
The state of the last job run. Possible values: |
|
|
The speed of the last job run |
|
|
The amount of uncompressed data during the last job run |
|
|
The duration of the last job run |
|
string |
Current state. Possible values: |
|
int |
The progress of the current job |
|
string |
Source object VID |
|
string |
Source object display name |
|
string |
Source object power state. Possible values: |
|
string |
Source object subtype |
|
string |
Target object VID |
|
string |
Target object display name |
|
string |
Target object power state. Possible values: |
|
string |
Target object subtype |
|
string |
The state of verification. Possible values: |
|
string |
The name of the screenshot used for verification |
|
string |
The state of the flash boot. Possible values: |
|
|
Bandwidth limit for the last job run |
|
array |
Transporter modes for the last job run. Possible values: |
lrLogicalSteps
|
||
|
array |
Transporter modes for the current job run. Possible values: |
|
string |
Screenshot path |
crSpeed
|
long
|
Job speed in bytes/s |
|
long
|
Size of uncompressed transferred data in bytes |
|
long
|
Data copy duration in milliseconds |
|
long
|
Bandwidth limit in bits/s |
transporters
Info about transporters used by a job
Field |
Value |
Description |
|
boolean |
Checks if the transporter was assigned automatically |
|
boolean |
Checks if the transporter used as a source |
|
boolean |
Checks if the transporter used as a target |
|
int |
Maximum number of jobs supported by the transporter |
|
int |
Current number of jobs using the transporter |
|
string |
VID of the transporter |
|
string |
Display name of the transporter |
|
string |
Current state of the transporter. Possible values: |
lrLogicalSteps
Info about logical steps of the last run job
Field |
Value |
Description |
|
string |
Step ID |
|
string |
Step display name |
|
string |
The state of the step. Possible values: |
|
string |
VID of the processed item |
|
string |
VID of the new processed item |
|
string |
The time when the step operation started |
|
string |
The time when the step operation finished |
|
|
The duration of the step |
|
int |
The number of step runs |
ProcessedProgress
|
int | The progress of the current step |
maxProgress
|
int | Maximum progress number of the current step |
startedJobExecutionStep
|
string | The time when the job execution step started |
finishedJobExecutionStep
|
string | The time when the job execution step finished |
stateJobExecutionStep
|
string | The state of the job execution step. |
durationJobExecutionStep
|
long
|
The duration of the job execution step |
storages
Info about storages used by jobs in a group
Field |
Value |
Description |
|
string |
Storage VID |
|
string |
Storage display name |
|
|
Full size of the storage |
|
|
Free space on the storage |
|
|
Used space on the storage |
|
string |
Storage status. Possible values: |
|
boolean |
Checks if the storage is online |
|
boolean |
AWS-specific: |
|
string |
The type of storage |
schedules
Job schedules. You may add more than one schedule
Field |
Type |
Description |
Possible Values or Format |
|
boolean |
If a schedule enabled, then |
|
|
string |
The type of backup schedule |
Possible values: |
|
int |
Priority of the schedule |
|
|
string |
Start time. |
|
|
string |
End time. null if not set |
|
|
string |
Time zone |
|
|
int |
A decimal representation of a bit mask for a day of a week. The lowest bit is Monday, the 7th is Sunday. For example, if you need to run a job on weekdays, the bitmask will be |
|
|
string |
If type is |
Possible values: |
|
int |
The number of delay units between job runs. For example, "Run job every |
|
|
string |
If type is |
|
|
int |
If |
|
|
int |
If |
|
|
int |
if |
|
|
string |
VID of the job that triggers the current one |
|
|
string |
Selects either to run the job immediately after the previous or within a delay. If |
|
|
array |
Trigger job conditions |
|
|
string |
Time and date of the next job run |
|
|
string |
The date that the schedule is effective from. It can be |
|
|
string |
Name of the trigger item |
|
|
string |
Name of trigger item type |
|
|
int |
Time zone offset in ms |
|
|
|
Relative time of the next job run in ms |
|