Get Processed VMs
Product version: 10.11
Last modified: 31 July 2024
Returns detailed info about VMs processed during the last N minutes (customizable up to a maximum of 1440).
Note
This request retrieves data for all VMs that the product has completed processing, as well as those currently undergoing processing within the last N minutes. For instance, if N equals 1440 (equivalent to 24 hours) and a job run starts at 2 pm and ends at 6 pm, then an API request made at 5 pm the next day will provide information on all VMs processed during that run, including those currently in progress.
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": "getProcessedVms",
"data": [{
"periodMinutes": 1440
}],
"type": "rpc",
"tid": 1}'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
curl
Copy
{
"action": "JobSummaryManagement",
"method": "getProcessedVms",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": {
"jobInfoList": [
{
"vid": "JOB-2",
"name": "Running",
"jobType": "BACKUP",
"vmInfoList": [
{
"vid": "VM-36",
"name": "@a",
"runInfoList": [
{
"vid": "JOB_EXECUTION_STEP-14",
"state": "SKIPPED",
"jobExecutionState": "SKIPPED",
"startDate": "2024-05-09T14:13:01.156+07:00",
"finishDate": "2024-05-09T14:13:01.161+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [],
"scheduleId": 3,
"scheduleName": "Schedule # 1",
"fullBackup": false,
"sourceTransporterHost": null,
"targetTransporterHost": null,
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-11",
"state": "SKIPPED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T14:12:57.815+07:00",
"finishDate": "2024-05-09T14:12:58.986+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": null,
"targetTransporterHost": null,
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-8",
"state": "SUCCEEDED",
"jobExecutionState": "STOPPED",
"startDate": "2024-05-09T14:02:59.914+07:00",
"finishDate": "2024-05-09T14:03:21.633+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-6",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T14:00:51.884+07:00",
"finishDate": "2024-05-09T14:01:07.306+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
}
]
},
{
"vid": "VM-3",
"name": "flashboot_automation_Win98_VM1",
"runInfoList": [
{
"vid": "JOB_EXECUTION_STEP-13",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T14:12:59.014+07:00",
"finishDate": "2024-05-09T14:18:08.695+07:00",
"retryCount": 0,
"dataTransferred": 314574750,
"dataTransferredUncompressed": 314572800,
"dataTransferredLastRetry": 314574750,
"dataTransferredUncompressedLastRetry": 314572800,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-10",
"state": "STOPPED",
"jobExecutionState": "STOPPED",
"startDate": "2024-05-09T14:02:59.809+07:00",
"finishDate": "2024-05-09T14:08:20.177+07:00",
"retryCount": 0,
"dataTransferred": 314574750,
"dataTransferredUncompressed": 314572800,
"dataTransferredLastRetry": 314574750,
"dataTransferredUncompressedLastRetry": 314572800,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
}
]
},
{
"vid": "VM-40",
"name": "@!#$%&*()P@ssword123@-+_9876",
"runInfoList": [
{
"vid": "JOB_EXECUTION_STEP-12",
"state": "SKIPPED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T14:12:57.815+07:00",
"finishDate": "2024-05-09T14:12:58.936+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": null,
"targetTransporterHost": null,
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-9",
"state": "SUCCEEDED",
"jobExecutionState": "STOPPED",
"startDate": "2024-05-09T14:02:59.770+07:00",
"finishDate": "2024-05-09T14:03:19.749+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-7",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T14:00:51.980+07:00",
"finishDate": "2024-05-09T14:01:05.337+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 3,
"scheduleName": "Manual run",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
}
]
}
]
},
{
"vid": "JOB-1",
"name": "Overlap",
"jobType": "BACKUP",
"vmInfoList": [
{
"vid": "VM-36",
"name": "@a",
"runInfoList": [
{
"vid": "JOB_EXECUTION_STEP-4",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T12:24:02.932+07:00",
"finishDate": "2024-05-09T12:24:20.403+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 1,
"scheduleName": "Schedule # 1",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Yearly: 3 years"
},
{
"vid": "JOB_EXECUTION_STEP-3",
"state": "SKIPPED",
"jobExecutionState": "SKIPPED",
"startDate": "2024-05-09T12:24:00.720+07:00",
"finishDate": "2024-05-09T12:24:00.733+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [],
"scheduleId": 2,
"scheduleName": "Schedule # 2",
"fullBackup": false,
"sourceTransporterHost": null,
"targetTransporterHost": null,
"retentionInfo": "Daily: 10 days"
},
{
"vid": "JOB_EXECUTION_STEP-1",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T12:22:02.191+07:00",
"finishDate": "2024-05-09T12:22:20.227+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 2,
"scheduleName": "Schedule # 2",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
}
]
},
{
"vid": "VM-40",
"name": "@!#$%&*()P@ssword123@-+_9876",
"runInfoList": [
{
"vid": "JOB_EXECUTION_STEP-5",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T12:24:02.931+07:00",
"finishDate": "2024-05-09T12:24:18.407+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 1,
"scheduleName": "Schedule # 1",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Yearly: 3 years"
},
{
"vid": "JOB_EXECUTION_STEP-2",
"state": "SUCCEEDED",
"jobExecutionState": "SUCCEEDED",
"startDate": "2024-05-09T12:22:02.221+07:00",
"finishDate": "2024-05-09T12:22:18.394+07:00",
"retryCount": 0,
"dataTransferred": 0,
"dataTransferredUncompressed": 0,
"dataTransferredLastRetry": 0,
"dataTransferredUncompressedLastRetry": 0,
"transporterModes": [
"LAN"
],
"scheduleId": 2,
"scheduleName": "Schedule # 2",
"fullBackup": true,
"sourceTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"targetTransporterHost": {
"vid": "TRANSPORTER-1",
"name": "Onboard transporter"
},
"retentionInfo": "Daily: 10 days"
}
]
}
]
}
]
}
}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 |
|---|---|---|
|
|
string |
Job VID |
name
|
string | Job name |
|
|
String |
Job type. Possible values: |
vmInfoList
|
Json | The vmInfoList list of related VMs. See the table below |
data.children.children
|
Field |
Type |
Description |
|---|---|---|
|
|
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 |
|---|---|---|
|
|
string |
VID of the job execution step |
state
|
string | State of the job execution step. Possible values: WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED |
jobExecutionState
|
string | State of the job execution. Possible values: WAITING, RUNNING, STOPPED, FAILED, SUCCEEDED, SKIPPED |
|
|
DateTime |
Start date and time of the job execution step |
|
|
DateTime |
Finish date and time of the job execution step |
|
|
int |
The number of job execution retries |
dataTransferred
|
long | Data transferred in bytes |
dataTransferredUncompressed
|
long | Data transferred uncompressed in bytes |
dataTransferredLastRetry
|
long | Data transferred during the last retry in bytes |
dataTransferredUncompressedLastRetry
|
long | Data transferred uncompressed during the last retry in bytes |
transporterModes
|
string |
The modes of data transfer. Possible values: |
scheduleId
|
int | Schedule ID |
scheduleName
|
string | Display schedule name |
fullBackup
|
boolean | true if the Full backup mode is enabled |
sourceTransporterHost
|
string | The source Transporter host data |
targetTransporterHost
|
string | The target Transporter host data |
retentionInfo
|
string | Retention data |