Skip to navigation

Get GPU VM metric timeseries

Returns rolled-up metric series for a GPU VM over a supported time range. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VM_ID: Virtual machine ID
curl "https://api.ibee.ai/v1/compute/gpu-vms/$VM_ID/metrics/timeseries?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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_idstringRequired
Virtual machine ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

rangeenumOptionalDefaults to 1h

Time window to return, ending now.

  • 30m
  • 1h
  • 6h
  • 24h
  • 7d

Default 1h.

Allowed values:

Response

VM metric timeseries returned successfully.
rangeenum

Window covered.

  • 30m
  • 1h
  • 6h
  • 24h
  • 7d
Allowed values:
resolutionenum

Spacing between points.

  • 1m
  • 5m
  • 15m
  • 2h
Allowed values:
fromdatetime

Start of the window (ISO 8601).

todatetime

End of the window (ISO 8601).

seriesmap from strings to lists of lists of any

Map of series name to [timestamp, value] pairs; value is null where no sample exists. Series: cpu_percent, memory_used_percent, storage_used_percent, disk_read_bps, disk_write_bps, disk_read_iops, disk_write_iops, net_rx_bps, net_tx_bps.

Errors

400
Bad Request Error
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