Zerto APIs : Resources Report API : Response In Json Format
  
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/reports/resources:
[{
  "Performance": {
    "BandwidthInBps": -1,
    "ThroughputInBps": -1
  },
  "ProtectedSite": {
    "SiteName": "string content",
    "VcdOrgName": "",
    "Compute": {
      "ClusterName": "string content",
      "HostName": "string content",
      "OrgVdcName": "",
      "ResourcePoolName": "",
      "VraName": "string content"
    },
    "Storage": {
      "VolumesProvisionedStorageInGB": 0.516,
      "VolumesUsedStorageInGB": 0.498,
      "NumberOfVolumes": 3
    },
    "VmInfo": {
      "Cpu": {
        "CpuLimitationInMhz": 0,
        "CpuReservedInMhz": 0,
        "CpuUsedInMhz": 0,
        "NumberOfvCpus": 1
      },
      "HardwareVersion": "string content",
      "Memory": {
        "ActiveGuestMemoryInMB": 15,
        "ConsumedHostMemoryInMB": 90,
        "MemoryInMB": 256,
        "MemoryLimitationInMB": 0,
        "MemoryReservedInMB": 0
      },
      "VmIdentifier": "string content",
      "VmName": "string content"
    }
  },
  "RecoverySite": {
    "SiteName": "string content",
    "VcdOrgName": "",
    "Compute": {
      "ClusterName": "string content",
      "HostName": "string content",
      "OrgVdcName": "",
      "ResourcePoolName": "",
      "VraName": "string content",
      "FailoverOrMoveInstanceFamily": "",
      "FailoverOrMoveInstanceType": "",
      "FailoverTestInstanceFamily": "",
      "FailoverTestInstanceType": ""
    },
    "Storage": {
      "VolumesProvisionedStorageInGB": 0.516,
      "VolumesUsedStorageInGB": 0,
      "DatastoreName": "string content,
      "JournalProvisionedStorageInGB": 16,
      "JournalUsedStorageInGB": 0.306,
      "StoragePolicyName": ""
    }
  },
  "SampleTime": "2018-04-12T21:59:59.000Z",
  "Vpg": {
    "CrmIdentifier": "",
    "ProtectedAndRecoveryType": "VC2VC",
    "ServiceProfileName": "",
    "VpgName": "string content",
    "ZorgName": ""
  }
}]
 
 
Parameter
description
Performance
BandwidthInBps
The average bandwidth used between two consecutive samples, in bytes per second.
A value of -1 means that data is not transferred.
ThroughputInBps
The average throughput used between two consecutive samples, in bytes per second.
A value of -1 means that data is not transferred.
ProtectedSite
SiteName
The name of the protected site.
VcdOrgName
The name of the vCD organization in the protected site.
Compute
ClusterName
The name of the cluster containing the host where the virtual machine in the protected site resides.
HostName
The address or DNS name of the host where the virtual machine in the protected site resides.
OrgVdcName
The name of the vDC organization in the protected site.
ResourcePoolName
The name of the resource pool hosting the virtual machine.
VraName
The name of the VRA.
Storage
VolumesProvisionedStorageInGB
The amount of provisioned storage for the virtual machine in the protected site. This value is the sum of the provisioned size of all the volumes.
VolumesUsedStorageInGB
The amount of storage used by the virtual machine in the protected site. This value is the sum of the used storage of all the volumes.
NumberOfVolumes
The number of volumes attached to the virtual machine.
VmInfo
Cpu
CpuLimitationInMhz
The maximum MHz available for the CPUs in the virtual machine.
CpuReservedInMhz
The MHz reserved for use by the CPUs in the virtual machine.
CpuUsedInMhz
The MHz used by the CPUs in the virtual machine.
NumberOfvCpus
The number of vCPUs for the virtual machine.
HardwareVersion
The VMware hardware version.
Memory
ActiveGuestMemoryInMB
The amount of memory used by the guest OS of the virtual machine.
ConsumedHostMemoryInMB
The amount of memory the host consumes.
MemoryInMB
The total amount of memory defined for the virtual machine.
MemoryLimitationInMB
The upper limit for the virtual machine’s memory allocation.
MemoryReservedInMB
The reserved memory allocation for this virtual machine.
VmIdentifier
The identifier of the VM.
VmName
The name of the VM.
RecoverySite
SiteName
The name of the recovery site.
VcdOrgName
The name of the vCD organization in the recovery site.
Compute
ClusterName
The name of the cluster containing the host where the virtual machine in the recovery site resides.
HostName
The address or DNS name of the host where the virtual machine in the recovery site resides.
OrgVdcName
The name of the vDC organization in the recovery site.
ResourcePoolName
The name of the resource pool hosting the virtual machine.
VraName
The name of the VRA.
FailoverOrMoveInstanceFamily
The instance family from which to select the instance type.
FailoverOrMoveInstanceType
The type of instance used when performing a failover or a move.
FailoverTestInstanceFamily
The instance family from which to select the instance types.
FailoverTestInstanceType
The type of instance used when testing a failover.
Storage
VolumesProvisionedStorageInGB
The provisioned storage for the virtual machine in the recovery site. This value is the sum of the provisioned size of all the volumes.
VolumesUsedStorageInGB
The used storage for the virtual machine in the recovery site. This value is the sum of the used storage of all the volumes.
DatastoreName
The name of the datastore.
JournalProvisionedStorageInGB
The provisioned journal storage for the virtual machine.
JournalUsedStorageInGB
The used journal storage for the virtual machine.
StoragePolicyName
The name of the storage policy in which the VM configuration files will reside.
SampleTime
The date and time the resource information was collected.
Vpg
CrmIdentifier
The cloud resource manager (CRM) identifier defined in the Zerto Cloud Manager for a ZORG.
ProtectedAndRecoveryType
The VPG type. Possible values are:
VC2VC: vCenter to vCenter replication.
VC2VCD: vCenter to vCloud Director replication.
VCD2VCD: vCloud Director to vCloud Director replication.
VCD2VC: vCloud Director to vCenter replication.
ServiceProfileName
The name of the service profile defined in the Zerto Cloud Manager.
VpgName
The name of the VPG.
ZorgName
The name of the ZORG as defined in the Zerto Cloud Manager.
XML Response Format
For the XML response format, see “Resources Report API XML Response Formats”, on page 364.
 
API Response Fields: Old and New
Current field name
Previous field name
BandwidthInBps
BandwidthInBytes
ThroughputInBps
ThroughputInBytes
ProtectedSite
SourceSite
SiteName
SourceSite
VcdOrgName
SourceVCDOrg
ClusterName
SourceCluster
HostName
SourceHost
OrgVdcName
SourceOrgVDC
ResourcePoolName
SourceResourcePool
VraName
SourceVraName
VolumesProvisionedStorageInGB
SourceVolumesProvisionedStorageInGB
VolumesUsedStorageInGB
SourceVolumesUsedStorageInGB
NumberOfVolumes
NumberOfVolumes
CpuLimitationInMhz
CpuLimitInMhz
CpuReservedInMhz
CpuReservedInMhz
CpuUsedInMhz
CpuUsedInMhz
NumberOfvCpus
NumberOfvCpus
HardwareVersion
VmHardwareVersion
ActiveGuestMemoryInMB
ActiveGuestMemoryInMB
ConsumedHostMemoryInMB
ConsumedHostMemoryInMB
MemoryInMB
MemoryInMB
MemoryLimitationInMB
MemoryLimitInMb
MemoryReservedInMB
MemoryReservedInMB
VmIdentifier
VmIdentifier
VmName
VmName
RecoverySite
TargetSite
SiteName
TargetSite
VcdOrgName
TargetVCDOrg
ClusterName
TargetCluster
HostName
TargetHost
OrgVdcName
TargetOrgVDC
ResourcePoolName
TargetResourcePool
VraName
TargetVraName
FailoverOrMoveInstanceFamily
Failover\Move Instance Family\VM Series
FailoverOrMoveInstanceType
Failover\Move Instance Type\VM Size
FailoverTestInstanceFamily
Failover Test Instance Family\VM Series
FailoverTestInstanceType
Failover Test Instance Type\VM Size
VolumesProvisionedStorageInGB
RecoveryVolumesProvisionedStorageInGB
VolumesUsedStorageInGB
RecoveryVolumesUsedStorageInGB
DatastoreName
TargetDatastores
JournalProvisionedStorageInGB
RecoveryJournalProvisionedStorageInGB
JournalUsedStorageInGB
RecoveryJournalUsedStorageInGB
StoragePolicyName
StorageProfile
SampleTime
TimeStamps
CrmIdentifier
CrmId
ProtectedAndRecoveryType
vpgType
ServiceProfileName
ServiceProfile
VpgName
VpgName
ZorgName
ZORG
See Also
Managing vCD APIs