Page tree

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)
actionstring
JobSummaryManagement
methodstring
getGroupInfo
dataarrayParameters
typestringrpc
tidinteger1

Data

Field
Type
Description
idListintGroup ID. null is the top group identifier (lists all jobs).
clientTimeOffsetToUtc intClient's current time zone offset to UTC (seconds).
collectAllChildJobs booleanTrue 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
messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure
dataJSON

Job summary info.

data.children

FieldValueDescription
idintJob group ID
vidstringJob group VID
namestringJob group display name
statusstringJob status
jobCountJSONThe number of jobs inside the group, grouped by hypervisor
jobCountEnabledintThe number of enabled jobs
jobCountLicensedintThe number of jobs that don't violate the license
hvTypeBackupCountJSONThe number of backups grouped by hypervisor
hvTypeBackupHasRootDiskCountJSONAWS-specific: backup count which savepoints have a Root volume
vmCountintThe number of VMs processed by the jobs inside a group
diskCountintThe number of disks processed by the jobs inside a group
sourcesSizeintTotal size of the sources processed by the jobs inside a group (in bytes)
isEnabledbooleanChecks if the group is enabled
isRemovedbooleanChecks if the group is removed
crJobRunningintThe number of currently running jobs
crVmRunningintThe number of currently processed VMs
hasLastRunbooleantrue if the job had the last run
lrJobOkintNumber of successful last runs
lrJobFailedintThe number of failed jobs
lrJobStoppedintThe number of stopped jobs
childJobIdsarray of intThe IDs of the child jobs
immediateChildJobIdsarray of intThe IDs of the direct children of a group
transportersarray of JSONInfo about the transporters involved. See below
storagesarray of JSON

Info about the storage involved. See below

transporters

Info about transporters used by jobs in a group.

FieldValueDescription
isAutobooleanChecks if a Transporter was assigned automatically
usedAsSourcebooleanChecks if a Transporter used as a source
usedAsTargetbooleanChecks if a Transporter used as a target
maxLoadFactorintMaximum number of jobs supported by a transporter
currentTotalLoadintCurrent number of jobs using a transporter
vidstringVID of a Transporter
namestringDisplay name of a Transporter
statestringCurrent state of a Transporter
storages 

Info about storages used by jobs in a group.

FieldValueDescription
vidstringStorage VID
namestringStorage display name
sizelongFull size of the storage
freelongFree space on the storage
usedlongUsed space on the storage
statestringStorage status
onlinebooleanChecks if the storage is online
infiniteSizebooleanAWS-specific: true if the EBS or EBS Snapshot Storage is used
typestringThe type of storage



  • No labels