Skip to main content

VmMetricsResponse

A VM metrics time series for a given timeframe.

timeframeMetricsTimeframe (string)

The time window over which VM metrics are aggregated on the VM metrics endpoint.

Hour — The last hour. Day — The last day. Week — The last week. Month — The last month. Year — The last year.

Possible values: [Hour, Day, Week, Month, Year]

rangeFromUtcstring<date-time>

Start of the sampled range, in UTC.

rangeToUtcstring<date-time>

End of the sampled range, in UTC.

samples object[]nullable

The individual metric samples within the range, ordered by time.

  • Array [
  • sampledAtUtcstring<date-time>

    Timestamp the sample was taken at, in UTC.

    cpuLoadPercentnumber<double>nullable

    CPU load, as a percentage of total available CPU.

    cpuTotalinteger<int32>nullable

    Total number of CPU cores allocated to the VM at sample time.

    ramUsedGbnumber<double>nullable

    RAM used, in gigabytes.

    ramTotalGbnumber<double>nullable

    Total RAM allocated to the VM, in gigabytes.

    diskUsedGbnumber<double>nullable

    Disk space used, in gigabytes.

    diskTotalGbnumber<double>nullable

    Total disk space allocated to the VM, in gigabytes.

    netInBytesPerSecondnumber<double>nullable

    Inbound network throughput, in bytes per second.

    netOutBytesPerSecondnumber<double>nullable

    Outbound network throughput, in bytes per second.

    diskReadBytesPerSecondnumber<double>nullable

    Disk read throughput, in bytes per second.

    diskWriteBytesPerSecondnumber<double>nullable

    Disk write throughput, in bytes per second.

  • ]
  • VmMetricsResponse
    {
    "timeframe": "Hour",
    "rangeFromUtc": "2024-07-29T15:51:28.071Z",
    "rangeToUtc": "2024-07-29T15:51:28.071Z",
    "samples": [
    {
    "sampledAtUtc": "2024-07-29T15:51:28.071Z",
    "cpuLoadPercent": 0,
    "cpuTotal": 0,
    "ramUsedGb": 0,
    "ramTotalGb": 0,
    "diskUsedGb": 0,
    "diskTotalGb": 0,
    "netInBytesPerSecond": 0,
    "netOutBytesPerSecond": 0,
    "diskReadBytesPerSecond": 0,
    "diskWriteBytesPerSecond": 0
    }
    ]
    }