Get GPU VM metrics
Returns current resource-usage metrics for a GPU VM. Requires scope: vm.read.
Authentication
AuthorizationBearer
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Path parameters
vm_id
Virtual machine ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Response
VM metrics returned successfully.
vm_id
ID of the VM.
vm_type
cloudgpu
Allowed values:
power_state
Power state observed on the host when the sample was taken: running, stopped, paused, suspended, blocked, crashed or unknown.
monitoring_status
active: a recent sample exists.stale: the last sample is older than the freshness threshold.unavailable: no sample has been collected.
Allowed values:
month_rx_bytes
Bytes received so far in the current calendar month.
month_tx_bytes
Bytes transmitted so far in the current calendar month.
last_collected_at
When the sample was collected (ISO 8601).
cpu_percent
CPU utilisation, 0-100.
memory_used_bytes
Memory in use, in bytes.
memory_used_percent
Memory in use as a percentage of the VM’s memory, 0-100.
storage_used_bytes
Disk space in use, in bytes.
storage_total_bytes
Disk capacity visible to the guest, in bytes.
storage_used_percent
Disk space in use as a percentage of storage_total_bytes, 0-100.
storage_provisioned_bytes
Disk capacity provisioned for the VM, in bytes.
disk_read_bps
Disk read throughput in bytes per second.
disk_write_bps
Disk write throughput in bytes per second.
disk_read_iops
Disk read operations per second.
disk_write_iops
Disk write operations per second.
net_rx_bps
Network receive rate in bytes per second.
net_tx_bps
Network transmit rate in bytes per second.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
