API Reference

Compute

VMs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Metric Descriptors

List VM Metric Descriptors

GET/v1/compute/metric_descriptors

ModelsExpand Collapse

VMMetricDescriptor object { description, max_value, metric, 3 more }

Describes one metric a VM reports: how to name it, what its values mean, and the range they fall in.

description: string

What the metric measures.

max_value: number

Highest value the metric reports, or null when it has no ceiling of its own.

metric: string

Fully-qualified name of the metric, and the only spelling the metric query parameter accepts.

min_value: number

Lowest value the metric reports.

nullable: boolean

Whether a point’s value can be null. A null means the VM reported no observation for that period, which is what a stopped VM looks like.

unit: VMMetricUnit

Unit the values are expressed in.

One of the following:

"ratio"

"bytes"

"cores"

"bytes_per_second"

"operations_per_second"

VMMetricDescriptorList object { items, pagination }

items: array of VMMetricDescriptor { description, max_value, metric, 3 more }

description: string

What the metric measures.

max_value: number

Highest value the metric reports, or null when it has no ceiling of its own.

metric: string

Fully-qualified name of the metric, and the only spelling the metric query parameter accepts.

min_value: number

Lowest value the metric reports.

nullable: boolean

Whether a point’s value can be null. A null means the VM reported no observation for that period, which is what a stopped VM looks like.

unit: VMMetricUnit

Unit the values are expressed in.

One of the following:

"ratio"

"bytes"

"cores"

"bytes_per_second"

"operations_per_second"

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0