List Jobs in Group

List all jobs in a group.

To list all jobs pass null in data. See Data.

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

curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
		"action": "JobSummaryManagement",
		"method": "getGroupInfo",
		"data": [[null],0,false],
		"type": "rpc",
		"tid": 1}"

Request Fields

Field	Type	Value(s)
`action`	string	JobSummaryManagement
`method`	string	getGroupInfo
`data`	array	Parameters
`type`	string	`rpc`
`tid`	integer	1

Data

Field	Type	Description
`idList`	int	Group ID. `null` is the top group identifier (lists all jobs).
`clientTimeOffsetToUtc`	int	Client's current time zone offset to UTC (seconds).
`collectAllChildJobs`	boolean	True to get the full info for all child jobs, not only direct ones. This increases the resulting data size; the overall processing size is the same.

Response Sample

 {
  "action": "JobSummaryManagement",
  "method": "getGroupInfo",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "children": [
      {
        "id": -1,
        "vid": null,
        "name": null,
        "status": "GREEN",
        "jobCount": {
          "VMWARE": {
            "REPLICATION": 0,
            "BACKUP": 4,
            "RECOVERY_VMS": 0,
            "RECOVERY_FILES": 0,
            "RECOVERY_OBJECTS": 0,
            "BACKUP_COPY": 0,
            "FLASH_BOOT": 0
          },
          "AWS": {
            "REPLICATION": 0,
            "BACKUP": 0,
            "RECOVERY_VMS": 0,
            "RECOVERY_FILES": 0,
            "RECOVERY_OBJECTS": 0,
            "BACKUP_COPY": 0,
            "FLASH_BOOT": 0
          },
          "HYPERV": {
            "REPLICATION": 0,
            "BACKUP": 1,
            "RECOVERY_VMS": 0,
            "RECOVERY_FILES": 0,
            "RECOVERY_OBJECTS": 0,
            "BACKUP_COPY": 0,
            "FLASH_BOOT": 0
          },
          "NONE": {
            "REPLICATION": 0,
            "BACKUP": 0,
            "RECOVERY_VMS": 0,
            "RECOVERY_FILES": 0,
            "RECOVERY_OBJECTS": 0,
            "BACKUP_COPY": 1,
            "FLASH_BOOT": 0
          }
        },
        "jobCountEnabled": 5,
        "jobCountLicensed": 6,
        "hvTypeBackupCount": {
          "VMWARE": 6,
          "HYPERV": 7
        },
        "hvTypeBackupHasRootDiskCount": {},
        "vmCount": 14,
        "diskCount": 17,
        "sourcesSize": 902823936,
        "isEnabled": true,
        "isRemoved": false,
        "crJobRunning": 0,
        "crVmRunning": 0,
        "hasLastRun": true,
        "lrJobOk": 5,
        "lrJobFailed": 0,
        "lrJobStopped": 0,
        "childJobIds": [
          6,
          4,
          7,
          8,
          1,
          3
        ],
        "immediateChildJobIds": [
          6,
          4,
          7,
          8,
          1,
          3
        ],
        "transporters": [
          {
            "isAuto": true,
            "usedAsSource": false,
            "usedAsTarget": false,
            "maxLoadFactor": 0,
            "currentTotalLoad": 0,
            "vid": null,
            "name": null,
            "state": null
          },
          {
            "isAuto": false,
            "usedAsSource": true,
            "usedAsTarget": true,
            "maxLoadFactor": 6,
            "currentTotalLoad": 0,
            "vid": "TRANSPORTER-1",
            "name": "Onboard transporter",
            "state": "OK"
          }
        ],
        "storages": [
          {
            "vid": "BACKUP_REPOSITORY-3",
            "name": "Repo",
            "size": 8999835533312,
            "free": 2892103155712,
            "used": 330990548808,
            "state": "OK",
            "online": true,
            "infiniteSize": false,
            "type": null
          }
        ]
      }
    ],
    "totalCount": 1
  }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
data	JSON	Job summary info.

data.children

Field	Value	Description
`id`	int	Job group ID
`vid`	string	Job group VID
`name`	string	Job group display name
`status`	string	Job status
`jobCount`	JSON	The number of jobs inside the group, grouped by hypervisor
`jobCountEnabled`	int	The number of enabled jobs
`jobCountLicensed`	int	The number of jobs that don't violate the license
`hvTypeBackupCount`	JSON	The number of backups grouped by hypervisor
`hvTypeBackupHasRootDiskCount`	JSON	AWS-specific: backup count which savepoints have a Root volume.
`vmCount`	int	The number of VMs processed by the jobs inside a group
`diskCount`	int	The number of disks processed by the jobs inside a group
`sourcesSize`	int	Total size of the sources processed by the jobs inside a group (in bytes)
`isEnabled`	boolean	Checks if the group is enabled
`isRemoved`	boolean	Checks if the group is removed
`crJobRunning`	int	The number of currently running jobs
`crVmRunning`	int	The number of currently processed VMs
`hasLastRun`	boolean	`true` if the job had the last run
`lrJobOk`	int	Number of successful last runs
`lrJobFailed`	int	The number of failed jobs
`lrJobStopped`	int	The number of stopped jobs
`childJobIds`	array of int	The IDs of the child jobs
`immediateChildJobIds`	array of int	The IDs of the direct children of a group
`transporters`	array of JSON	Info about the transporters involved. See below
`storages`	array of JSON	Info about the storage involved. See below

transporters

Info about transporters used by jobs in a group.

Field	Value	Description
`isAuto`	boolean	Checks if a Transporter was assigned automatically
`usedAsSource`	boolean	Checks if a Transporter used as a source
`usedAsTarget`	boolean	Checks if a Transporter used as a target
`maxLoadFactor`	int	Maximum number of jobs supported by a transporter
`currentTotalLoad`	int	Current number of jobs using a transporter
`vid`	string	VID of a Transporter
`name`	string	Display name of a Transporter
`state`	string	Current state of a Transporter

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
`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

Page tree