Skip to main content

VmStateCountsResponse

The number of VMs in a project, broken down two ways: by lifecycle status and by power state. These are computed server-side, so they stay accurate regardless of how many VMs the project has (unlike counting a paged VM list on the client).

totalinteger<int32>

Total number of VMs in the project. Equal to the sum of the byStatus fields.

byStatus object

Number of VMs in each lifecycle status.

creatinginteger<int32>

VMs that are being provisioned and are not ready to use yet.

activeinteger<int32>

VMs that exist and are in a normal, ready-to-use state.

updatinginteger<int32>

VMs that are having a change applied (for example start, stop, reboot, resize or rebuild).

deletinginteger<int32>

VMs that are being deleted.

failedinteger<int32>

VMs that entered a state they cannot recover from automatically and need manual intervention.

byPowerState object

Number of VMs in each power state.

runninginteger<int32>

VMs that are powered on.

stoppedinteger<int32>

VMs that are powered off.

VmStateCountsResponse
{
"total": 0,
"byStatus": {
"creating": 0,
"active": 0,
"updating": 0,
"deleting": 0,
"failed": 0
},
"byPowerState": {
"running": 0,
"stopped": 0
}
}