Version 5.0

REST Resource: projects.locations.sources.utilizationReports

Resource: UtilizationReport

Utilization report details the utilization (CPU, memory, etc.) of selected source VMs.

JSON representation
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "stateTime": string,
  "error": {
    object (Status)
  },
  "createTime": string,
  "timeFrame": enum (TimeFrame),
  "frameEndTime": string,
  "vmsCount": integer,
  "vmCount": integer,
  "vms": [
    {
      object (VmUtilizationInfo)
    }
  ]
}
Fields
name

string

Output only. The report unique name.

displayName

string

The report display name, as assigned by the user.

state

enum (State)

Output only. Current state of the report.

stateTime

string (Timestamp format)

Output only. The time the state was last set.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

error

object (Status)

Output only. Provides details on the state of the report in case of an error.

createTime

string (Timestamp format)

Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

timeFrame

enum (TimeFrame)

Time frame of the report.

frameEndTime

string (Timestamp format)

Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frameEndTime" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

vmsCount
(deprecated)

integer

Output only. Total number of VMs included in the report.

vmCount

integer

Output only. Total number of VMs included in the report.

vms[]

object (VmUtilizationInfo)

List of utilization information per VM. When sent as part of the request, the "vmId" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored.

State

Utilization report state.

Enums
STATE_UNSPECIFIED The state is unknown. This value is not in use.
CREATING The report is in the making.
SUCCEEDED Report creation completed successfully.
FAILED Report creation failed.

TimeFrame

Report time frame options.

Enums
TIME_FRAME_UNSPECIFIED The time frame was not specified and will default to WEEK.
WEEK One week.
MONTH One month.
YEAR One year.

VmUtilizationInfo

Utilization information of a single VM.

JSON representation
{
  "vmId": string,
  "utilization": {
    object (VmUtilizationMetrics)
  },
  "vmwareVmDetails": {
    object (VmwareVmDetails)
  }
}
Fields
vmId

string

The VM's ID in the source.

utilization

object (VmUtilizationMetrics)

Utilization metrics for this VM.

vmwareVmDetails

object (VmwareVmDetails)

The description of the VM in a Source of type Vmware.

VmwareVmDetails

VmwareVmDetails describes a VM in vCenter.

JSON representation
{
  "vmId": string,
  "datacenterId": string,
  "datacenterDescription": string,
  "uuid": string,
  "displayName": string,
  "powerState": enum (PowerState),
  "cpuCount": integer,
  "memoryMb": integer,
  "diskCount": integer,
  "committedStorage": string,
  "committedStorageMb": string,
  "guestDescription": string,
  "bootOption": enum (BootOption)
}
Fields
vmId

string

The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM.

datacenterId

string

The id of the vCenter's datacenter this VM is contained in.

datacenterDescription

string

The descriptive name of the vCenter's datacenter this VM is contained in.

uuid

string

The unique identifier of the VM in vCenter.

displayName

string

The display name of the VM. Note that this is not necessarily unique.

powerState

enum (PowerState)

The power state of the VM at the moment list was taken.

cpuCount

integer

The number of cpus in the VM.

memoryMb

integer

The size of the memory of the VM in MB.

diskCount

integer

The number of disks the VM has.

committedStorage
(deprecated)

string (int64 format)

The total size of the storage allocated to the VM in MB.

committedStorageMb

string (int64 format)

The total size of the storage allocated to the VM in MB.

guestDescription

string

The VM's OS. See for example https://pubs.vmware.com/vi-sdk/visdk250/ReferenceGuide/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.

bootOption

enum (BootOption)

Output only. The VM Boot Option.

PowerState

Possible values for the power state of the VM.

Enums
POWER_STATE_UNSPECIFIED Power state is not specified.
ON The VM is turned ON.
OFF The VM is turned OFF.
SUSPENDED The VM is suspended. This is similar to hibernation or sleep mode.

BootOption

Possible values for vm boot option.

Enums
BOOT_OPTION_UNSPECIFIED The boot option is unknown.
EFI The boot option is EFI.
BIOS The boot option is BIOS.

VmUtilizationMetrics

Utilization metrics values for a single VM.

JSON representation
{
  "cpuMax": integer,
  "cpuMaxPercent": integer,
  "cpuAverage": integer,
  "cpuAveragePercent": integer,
  "memoryMax": integer,
  "memoryMaxPercent": integer,
  "memoryAverage": integer,
  "memoryAveragePercent": integer,
  "diskIoRateMax": string,
  "diskIoRateMaxKbps": string,
  "diskIoRateAverage": string,
  "diskIoRateAverageKbps": string,
  "networkThroughputMax": string,
  "networkThroughputMaxKbps": string,
  "networkThroughputAverage": string,
  "networkThroughputAverageKbps": string
}
Fields
cpuMax
(deprecated)

integer

Max CPU usage, percent.

cpuMaxPercent

integer

Max CPU usage, percent.

cpuAverage
(deprecated)

integer

Average CPU usage, percent.

cpuAveragePercent

integer

Average CPU usage, percent.

memoryMax
(deprecated)

integer

Max memory usage, percent.

memoryMaxPercent

integer

Max memory usage, percent.

memoryAverage
(deprecated)

integer

Average memory usage, percent.

memoryAveragePercent

integer

Average memory usage, percent.

diskIoRateMax
(deprecated)

string (int64 format)

Max disk IO rate, in kilobytes per second.

diskIoRateMaxKbps

string (int64 format)

Max disk IO rate, in kilobytes per second.

diskIoRateAverage
(deprecated)

string (int64 format)

Average disk IO rate, in kilobytes per second.

diskIoRateAverageKbps

string (int64 format)

Average disk IO rate, in kilobytes per second.

networkThroughputMax
(deprecated)

string (int64 format)

Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

networkThroughputMaxKbps

string (int64 format)

Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

networkThroughputAverage
(deprecated)

string (int64 format)

Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

networkThroughputAverageKbps

string (int64 format)

Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.

Methods

create

Creates a new UtilizationReport.

delete

Deletes a single Utilization Report.

get

Gets a single Utilization Report.

list

Lists Utilization Reports of the given Source.