instance_view

Fetch instance
get/v1/instances/{instance}

Path Parameters

instance

Query Parameters

project

Responses

Object
auto_restart_cooldown_expiration

The time at which the auto-restart cooldown period for this instance completes, permitting it to be automatically restarted again. If the instance enters the Failed state, it will not be restarted until after this time.

If this is not present, then either the instance has never been automatically restarted, or the cooldown period has already expired, allowing the instance to be restarted immediately if it fails.

auto_restart_enabled

true if this instance's auto-restart policy will permit the control plane to automatically restart it if it enters the Failed state.

auto_restart_policy

The auto-restart policy configured for this instance, or null if no explicit policy has been configured.

This policy determines whether the instance should be automatically restarted by the control plane on failure. If this is null, the control plane will use the default policy when determining whether or not to automatically restart this instance, which may or may not allow it to be restarted. The value of the auto_restart_enabled field indicates whether the instance will be auto-restarted, based on its current policy or the default if it has no configured policy.

A policy determining when an instance should be automatically restarted by the control plane.

boot_disk_id

the ID of the disk used to boot this Instance, if a specific one is assigned.

description

human-readable free-form text about a resource

hostname

RFC1035-compliant hostname for the Instance.

id

unique, immutable, system-controlled identifier for each resource

memory

memory allocated for this Instance

Byte count to express memory or storage capacity.

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

ncpus

number of CPUs allocated for this Instance

The number of CPUs in an Instance

project_id

id for the project containing this Instance

run_state

Running state of an Instance (primarily: booted or stopped)

This typically reflects whether it's starting, running, stopping, or stopped, but also includes states related to the Instance's lifecycle

time_created

timestamp when this resource was created

time_last_auto_restarted

The timestamp of the most recent time this instance was automatically restarted by the control plane.

If this is not present, then this instance has not been automatically restarted.

time_modified

timestamp when this resource was last modified

time_run_state_updated