Get Job Info

Returns detailed job info.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

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	`JobSummaryManagement`
`method`	string	`getJobInfo`
`data`	array of int	Parameters
`type`	string	`rpc`
`tid`	integer	`1`

Data

Field	Type	Description
`idList`	array of int	Job IDs
`clientTimeOffsetToUtc`	int	Client's current timezone offset to UTC

Response Sample

curl

Copy

{
    "action": "JobSummaryManagement",
    "method": "getJobInfo",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "name": "SQL Backup Job",
                "id": 1,
                "vid": "JOB-1",
                "hvType": "VMWARE",
                "hvTypeBackupCount": {
                    "VMWARE": 2
                },
                "hvTypeBackupHasRootDiskCount": {},
                "status": "YELLOW",
                "jobType": "BACKUP",
                "added": "2017-06-26T21:19:48.807Z",
                "updated": "2017-06-26T21:19:48.807Z",
                "vmCount": 2,
                "diskCount": 3,
                "sourcesSize": 304087040,
                "isEnabled": true,
                "isLicensed": true,
                "isEdited": false,
                "isLocked": false,
                "isRemoved": false,
                "averageDurationMs": 1466773,
                "averageDurationSampleCount": 7,
                "crState": "WAITING_SCHEDULE",
                "crDate": null,
                "crDateRelative": 0,
                "crVmPlanned": 0,
                "crVmOk": 0,
                "crVmFailed": 0,
                "crVmStopped": 0,
                "crProgress": 0,
                "crAdhoc": false,
                "hasLastRun": true,
                "lrState": "STOPPED",
                "lrDate": "2017-08-11T01:00:01.686Z",
                "lrFinishDate": "2017-08-11T03:00:38.199Z",
                "lrSpeed": 29099188,
                "lrDurationMs": 7236513,
                "lrDataKb": 204177408,
                "lrVmOk": 0,
                "lrVmFailed": 0,
                "lrVmStopped": 2,
                "lrAdhoc": false,
                "lrCompressionRatio": 0,
                "differentialTrackingMode": "HYPERVISOR",
                "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": "VSS_IGNORE_ERRORS",
                "retentionPolicy": {
                    "retentionMode": "RULESET",
                    "maxCount": 10,
                    "keepDayCount": null,
                    "keepWeekCount": null,
                    "keepMonthCount": null,
                    "keepYearCount": null
                },
                "powerVmsOn": false,
                "generateMac": false,
                "recoveryType": null,
                "transporterMode": "AUTO",
                "logTruncationMode": "NONE",
                "screenshotVerificationMode": "NEVER",
                "objects": [
                    {
                        "vid": "JOB_OBJECT-1",
                        "lrState": "STOPPED",
                        "lrSpeed": 0,
                        "lrDataTransferredUncompressed": 0,
                        "lrDuration": 7200194,
                        "crState": "SCHEDULED",
                        "crProgress": 10000,
                        "sourceVid": "VM-41",
                        "sourceName": "vm#14_SQL2008r2_Standart_Win2008r2",
                        "sourcePowerState": "OFF",
                        "sourceSubType": "VM",
                        "targetVid": "BACKUP_OBJECT-5",
                        "targetName": "vm#14_SQL2008r2_Standart_Win2008r2",
                        "targetPowerState": "UNKNOWN",
                        "targetSubType": null,
                        "verificationState": null,
                        "screenshotName": null,
                        "flashBootState": "WAITING"                    },
                    {
                        "vid": "JOB_OBJECT-2",
                        "lrState": "STOPPED",
                        "lrSpeed": 29042598,
                        "lrDataTransferredUncompressed": 209077665792,
                        "lrDuration": 7199782,
                        "crState": "SCHEDULED",
                        "crProgress": 10000,
                        "sourceVid": "VM-30",
                        "sourceName": "vm#9_SQL2016installedonDdrive_WInSrv2016",
                        "sourcePowerState": "ON",
                        "sourceSubType": "VM",
                        "targetVid": "BACKUP_OBJECT-4",
                        "targetName": "vm#9_SQL2016installedonDdrive_WInSrv2016",
                        "targetPowerState": "UNKNOWN",
                        "targetSubType": null,
                        "verificationState": null,
                        "screenshotName": null,
                        "flashBootState": "WAITING"                    }
                ],
                "transporters": [
                    {
                        "isAuto": true,
                        "usedAsSource": false,
                        "usedAsTarget": false,
                        "maxLoadFactor": 0,
                        "currentTotalLoad": 0,
                        "vid": null,
                        "name": null,
                        "state": null
                    },
                    {
                        "isAuto": false,
                        "usedAsSource": false,
                        "usedAsTarget": true,
                        "maxLoadFactor": 6,
                        "currentTotalLoad": 0,
                        "vid": "TRANSPORTER-1",
                        "name": "Onboard transporter",
                        "state": "OK"                    }
                ],
                "storages": [
                    {
                        "vid": "BACKUP_REPOSITORY-3",
                        "name": "Repo",
                        "size": 8999835533312,
                        "free": 2817293680640,
                        "used": 371267032097,
                        "state": "OK",
                        "online": true,
                        "infiniteSize": false,
                        "type": null
                    }
                ],
                "schedules": [
                    {
                        "enabled": true,
                        "type": "DAILY",
                        "monthlyEveryType": "LAST",
                        "everyType": "MINUTE",
                        "every": 30,
                        "startTime": "04:00:00 AM",
                        "endTime": "06:00:00 AM",
                        "dayOfWeek": 5,
                        "dayOfMonth": 1,
                        "month": 0,
                        "timezone": "EET",
                        "on": 127,
                        "triggerItem": null,
                        "triggerRunType": null,
                        "triggerEvents": null,
                        "nextRun": "2017-08-12T01:00:00.000Z",
                        "position": 1,
                        "triggerItemName": null,
                        "timezoneOffsetMs": 10800000,
                        "nextRunRelative": 37083782
                    }
                ],
                "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
`name`	string	Display name
`id`	int	Job ID
`vid`	string	Job VID
`hvType`	string	Platform type
`hvTypeBackupCount`	Json	Number of machines by platform
`fromBackup`	boolean	Special case for a replication job: `true` if from Backup, `false` if from VM
`lrSiteRecoveryRunType`	string	Site recovery specific: the type of recovery running for the last job run. Possible values: `TEST, RUN`
`lrRecoveryTimeObjectiveType`	string	Site recovery specific: the type of recovery time objective for the last job run. Possible values: `MINUTE, HOUR`
`lrRecoveryTimeObjective`	int	Site recovery specific: the recovery time objective for the last job run
`lrFailoverType`	string	Site recovery specific: the failover type for the last job run. Possible values: `PLANNED_FAILOVER, EMERGENCY_FAILOVER`
`lrActionFailed`	int	Site recovery specific: action failed for the last job run
`lrActionSkipped`	int	Site recovery specific: action skipped for the last job run
`lrActionSucceed`	int	Site recovery specific: action succeeded for the last job run
`lrActionStopped`	int	Site recovery specific: action stopped for the last job run
`postScriptPath`	string	Path to the post-script
`powerSourceVmsOff`	boolean	`true` if powering off the source VMs is needed
`sqlLogTruncationMode`	string	Truncation mode of Microsoft SQL Server logging. Possible values: `NONE, ALWAYS, JOB_SUCCESS`
`fullBackupRunSettingsType`	string	Type of full backup job run settings. Possible values: `ALWAYS, EVERY, EVERY2ND, FIRST, SECOND, THIRD, FOURTH, LAST, DAY, EVERY_JOB_RUNS`
`fullBackupMode`	string	Full backup mode. Possible values: `SYNTHETIC, ACTIVE`
`recoveryTimeObjectiveType`	string	Type of recovery time objective. Possible values: `MINUTE, HOUR`
`recoveryTimeObjective`	int	Recovery time objective
`crSiteRecoveryRunType`	string	Specific for site recovery job: the type of site recovery running for the current job run. Possible values: `TEST, RUN`
`crRecoveryTimeObjectiveType`	string	Specific for site recovery job: the type of recovery time objective for the current job run. Possible values: `MINUTE, HOUR`
`crRecoveryTimeObjective`	int	Specific for site recovery job: the recovery time objective for the current job run
`crFailoverType`	string	Specific for site recovery job: the failover type for the current job run. Possible values: `PLANNED_FAILOVER, EMERGENCY_FAILOVER`
`actions`	array	List of actions
`crActionExecutions`	array	List of actions for the current job run
`lrActionExecutions`	array	List of action for the last job run
`hvTypeBackupHasRootDiskCount`	Json	AWS-specific: backup count which savepoints have a Root volume
`status`	string	Job status
`jobType`	string	Job type. Possible values: `REPLICATION, BACKUP, RECOVERY_VMS, RECOVERY_FILES, RECOVERY_OBJECTS, BACKUP_COPY, FLASH_BOOT, REPLICA_FAILOVER, SITE_RECOVERY`
`added`	string	Date added
`updated`	string	Date updated
`vmCount`	int	The number of machines
`diskCount`	int	The number of disks
`sourcesSize`	long	The total size of source machines
`isEnabled`	boolean	Checks if the job is enabled
`isLicensed`	boolean	Checks if the job does not violate license
`isEdited`	boolean	Checks if the job was edited
`isLocked`	boolean	Checks if the job was locked
`isRemoved`	boolean	Checks if the job was removed
`averageDurationMs`	long	The average job duration (in ms)
`averageDurationSampleCount`	int	The number of job runs to calculate average job duration
`crState`	string	Current state. Possible values: `WAITING_DEMAND, WAITING_SCHEDULE, RUNNING, OK, FAILED, STOPPED`
`crDate`	string	Timestamp of the current job run
`crDateRelative`	long	Relative timestamp (time passed from the job start run) of the current job run
`crVmPlanned`	int	The number of machines queued for processing for the current job run
`crVmOk`	int	The number of successfully processed machines during the current job run
`crVmFailed`	int	The number of failed machines during the current job run
`crVmStopped`	int	The number of machines stopped during the current job run
`crProgress`	int	Current job run progress
`crAdhoc`	boolean	`true` if the current job run was started manually (not on schedule)
`hasLastRun`	boolean	Checks if the job had a last run
`lrState`	string	The state of the last job run. Possible values: `WAITING_DEMAND, WAITING_SCHEDULE, RUNNING, OK, FAILED, STOPPED`
`lrDate`	string	The date and time of the last job run start
`lrFinishDate`	string	The date and time of the last job run end
`lrSpeed`	long	The speed of the last job run
`lrDurationMs`	long	The duration of the last job run
`lrDataKb`	long	Data transferred during the last job run
`lrVmOk`	int	Number of successfully processed machines during the last job run
`lrVmFailed`	int	Number of machines failed during the last job run
`lrVmStopped`	int	Number of machines stopped during the last job run
`lrAdhoc`	boolean	`true` if the last job run was started manually (not on schedule)
`lrCompressionRatio`	int	The compression ratio during the last job run
`differentialTrackingMode`	string	A method used for forever-incremental backup. Possible values: `NONE, HYPERVISOR, DOUBLE_CHECK, PROPRIETARY`
`preScriptExecutionMode`	string	The mode of execution of pre-job scripts. Possible values: `NEVER, ALWAYS`
`preScriptBehavior`	string	Job behavior: either to wait for the script to finish or proceed. Possible values: `NONE, WAIT, PROCEED`
`preScriptErrorMode`	string	The job behavior on pre-job script failure. Possible values: `NONE, FAIL, SKIP`
`preScriptPath`	string	The path to the pre-job script
`postScriptExecutionMode`	string	The mode of execution of post-job scripts. Possible values: `NEVER, ALWAYS`
`postScriptBehavior`	string	Job behavior: either to wait for the script to finish or proceed. Possible values: `NONE, WAIT, PROCEED`
`postScriptErrorMode`	string	The job behavior on post-job script failure. Possible values: `NONE, FAIL, SKIP`
`thinDiskMode`	string	For replication: thin disk or respect source. Possible values: `AUTO, FORCE_THIN`
`ebsVolumeMode`	string	For AWS jobs only: a type of EBS volume. Possible values: `AUTO, FORCE_MAGNETIC`
`temporaryVolumeType`	string	For AWS jobs only: a type of a temporary volume
`networkAccelerationMode`	string	Network acceleration mode. Possible values: `NONE, AUTO, FAST, MEDIUM, BEST`
`encryptionMode`	string	Encryption mode. Possible values: `NONE, NORMAL`
`applicationAwareMode`	string	Application-aware mode. Possible values: `NONE, VSS_IGNORE_ERRORS, VSS_FAIL_ON_ERRORS`
`retentionPolicy`	Json	Retention policy options. See below
`powerVmsOn`	boolean	Recovery only. Defines if the recovered machines must be powered on after the job is completed
`generateMac`	boolean	Recovery only. Defines if a new MAC-address should be generated for the recovered machine
`recoveryType`	string	Recovery type. Possible values: `SYNTHETIC, PRODUCTION`
`transporterMode`	string	The mode of data transfer. Possible values: `AUTO, SAN, LAN, HOT_ADD`
`exchangelogTruncationMode`	string	Mode of Microsoft Exchange log truncation. Possible values: `NONE, ALWAYS, JOB_SUCCESS`
`screenshotVerificationMode`	string	The mode of screenshot verification. Possible values: `NEVER, ALWAYS`
`objects`	array	Source objects
`transporters`	array	Transporters used
`storages`	array	Storages
`schedules`	array	Job schedules
`lockReasons`	array	If the job is locked, lock reasons

retentionPolicy

Field	Value	Description
`retentionMode`	string	Retention mode. The `RULESET` defines the retention rules. The `EXACT` is used for backup copy jobs and copies the rule set of the original backup	`RULESET,` `EXACT`
`maxCount`	int	Maximum number of recovery points
`keepDayCount`	int	Maximum number of days to keep a recovery point
`keepWeekCount`	int	Maximum number of weeks to keep a recovery point
`keepMonthCount`	int	Maximum number of months to keep a recovery point
`keepYearCount`	int	Maximum number of years to keep a recovery point

objects

Source job objects

Field	Values	Description
`vid`	string	VID of a job object
`lrState`	string	The state of the last job run. Possible values: `SCHEDULED, DEMAND, WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED`
`lrSpeed`	long	The speed of the last job run
`lrDataTransferredUncompressed`	long	The amount of uncompressed data during the last job run
`lrDuration`	long	The duration of the last job run
`crState`	string	Current state. Possible values: `SCHEDULED, DEMAND, WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED`
`crProgress`	int	The progress of the current job
`sourceVid`	string	Source object VID
`sourceName`	string	Source object display name
`sourcePowerState`	string	Source object power state. Possible values: `ON, OFF, SUSPENDED, UNKNOWN`
`sourceSubType`	string	Source object subtype
`targetVid`	string	Target object VID
`targetName`	string	Target object display name
`targetPowerState`	string	Target object power state. Possible values: `ON, OFF, SUSPENDED, UNKNOWN`
`targetSubType`	string	Target object subtype
`verificationState`	string	The state of verification. Possible values: `SCHEDULED, DEMAND, WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED`
`screenshotName`	string	The name of the screenshot used for verification
`flashBootState`	string	The state of the flash boot. Possible values: `WAITING, STARTING, RUNNING_VM, FAILED, DISCARDING, DISCARDED`
`lrBandwidthLimit`	long	Bandwidth limit for the last job run
`lrTransporterModes`	array	Transporter modes for the last job run. Possible values: `AUTO, SAN, LAN, HOT_ADD`
`crTransporterModes`	array	Transporter modes for the current job run. Possible values: `AUTO, SAN, LAN, HOT_ADD`
`screenshotPath`	string	Screenshot path
`crSpeed`	long	Job speed in bytes/s
`crDataTransferredUncompressed`	long	Size of uncompressed transferred data in bytes
`crDuration`	long	Data copy duration in milliseconds
`crBandwidthLimit`	long	Bandwidth limit in bits/s

transporters

Info about transporters used by a job

Field	Value	Description
`isAuto`	boolean	Checks if the transporter was assigned automatically
`usedAsSource`	boolean	Checks if the transporter used as a source
`usedAsTarget`	boolean	Checks if the transporter used as a target
`maxLoadFactor`	int	Maximum number of jobs supported by the transporter
`currentTotalLoad`	int	Current number of jobs using the transporter
`vid`	string	VID of the transporter
`name`	string	Display name of the transporter
`state`	string	Current state of the transporter. Possible values: `OK, WARNING, INACCESSIBLE, ERROR`

storages

Info about storages used by jobs in a group

Field	Value	Description
`vid`	string	Storage VID
`name`	string	Storage display name
`size`	long	Full size of the storage
`free`	long	Free space on the storage
`used`	long	Used space on the storage
`state`	string	Storage status. Possible values: `OK, WARNING, INACCESSIBLE, ERROR`
`online`	boolean	Checks if the storage is online
`infiniteSize`	boolean	AWS-specific: `true` if the EBS or EBS Snapshot Storage is used
`type`	string	The type of storage

schedules

Job schedules. You may add more than one schedule

Field	Type	Description	Possible Values or Format
`enabled`	boolean	If a schedule enabled, then `true`, `false` otherwise
`type`	string	The type of backup schedule	Possible values: `DAILY, PERIODICALLY, NONE, MONTHLY_YEARLY, TRIGGER`
`position`	int	Priority of the schedule
`startTime`	string	Start time.	`hh:mm:ss AM/PM`
`endTime`	string	End time. null if not set
`timezone`	string	Time zone
`on`	int	A decimal representation of a bit mask for a day of a week. The lowest bit is Monday, the 7^th is Sunday. For example, if you need to run a job on weekdays, the bitmask will be `00011111` which is 31 in decimal	`1-127`
`everyType`	string	If type is `PERIODICALLY` or `TRIGGERED`, defines the delay unit between jobs. For example, "Run job every `30 minutes`".	Possible values: `DAY` (for `PERIODICALLY` only), `SECOND, MINUTE, HOUR`
`every`	int	The number of delay units between job runs. For example, "Run job every `30 minutes`"
`monthlyEveryType`	string	If type is `MONTHLY_YEARLY` , selects the number of a weekday in a month or a day number	`FIRST,` `SECOND,` `THIRD,` `FOURTH,` `LAST,` `DAY`
`dayOfMonth`	int	If `monthlyEveryType` is `DAY`, selects the day number in a month
`dayOfWeek`	int	If `monthlyEveryType` is either from `LAST`, selects the number of a weekday
`month`	int	if `type` is `MONTHLY_YEARLY`, the number of the month when a job must be running
`triggerItem`	string	VID of the job that triggers the current one
`triggerRunType`	string	Selects either to run the job immediately after the previous or within a delay. If `DELAYED` is selected, the delay is defined by the `everyType` and `every` fields	`IMMEDIATELY, DELAYED`
`triggerEvents`	array	Trigger job conditions	`RUN_SUCCESS,` `RUN_FAILURE,` `RUN_STOP`
`nextRun`	string	Time and date of the next job run	`YYYY-MM-DDTHH:MM:SS.SSSZ`
`effectiveDate`	string	The date that the schedule is effective from. It can be `null`, so the schedule is effective from now
`triggerItemName`	string	Name of the trigger item
`triggerItemTypeName`	string	Name of trigger item type
`timezoneOffsetMs`	int	Time zone offset in ms
`nextRunRelative`	long	Relative time of the next job run in ms