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
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 |
| long | 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 |
| long | 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 |
| long | The speed of the last job run |
| long | The duration of the last job run |
| long | 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: |
| long | The speed of the last job run |
| long | The amount of uncompressed data during the last job run |
| long | 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: |
| long | Bandwidth limit for the last job run |
| array | Transporter modes for the last job run. Possible values: |
| 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: |
storages
Info about storages used by jobs in a group
Field | Value | Description |
| string | Storage VID |
| string | Storage display name |
| long | Full size of the storage |
| long | Free space on the storage |
| long | 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 |
|
| long | Relative time of the next job run in ms |
|