Get Processed VMs

Returns detailed info about VMs processed during the last N minutes (customizable up to a maximum of 1440).

Note

This request returns data for all VMs that the product has finished processing within the previous N minutes. For example, if N is 1440 (i.e. 24 hours) and a job run starts at 2pm and ends at 6pm, then an API request at 5pm on the following day will return all VMs processed during said run. 

As a result, data will not be returned for the following:

  • VMs in job runs that were skipped as a result of overlapping schedules

  • VMs in currently running jobs

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

Request Fields

Field

Type

Value(s)

action string
JobSummaryManagement
method string
getProcessedVms
data int Time period in minutes
type string rpc
tid integer 1

Response Sample

Response Fields

Field

Value

Description

message string Message if the request failed
where string Reference to the method where a problem occurred
cause string Cause of failure
data Json The jobInfoList list of related jobs. See the table below

data.children

Field

Type

Description

vid

string

Job VID

name string Job name

jobType

String

Job type. Possible values: BACKUP, BACKUP_COPY, FLASH_BOOT, RECOVERY_FILES, RECOVERY_OBJECTS, RECOVERY_VMS, REPLICA_FAILOVER, REPLICATION, SITE_RECOVERY, REPLICA_FAILBACK, RECOVERY_TAPE

vmInfoList Json The vmInfoList list of related VMs. See the table below

data.children.children

Field

Type

Description

vid

string

VM VID

name string VM name
runInfoList Json The runInfoList list of related job execution steps. See the table below

data.children.children.children

Field

Type

Description

vid

string

VID of the job execution step

state string State of the job execution step.  Possible values: WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED

startDate

DateTime

Start date and time of the job execution step

finishDate

DateTime

Finish date and time of the job execution step

dataTransferred long Data transferred in bytes
dataTransferredUncompressed long Data transferred uncompressed in bytes