instance _update
Path Parameters
Query Parameters
Request Body
Parameters of an Instance
that can be reconfigured after creation.
Sets the auto-restart policy for this instance.
This policy determines whether the instance should be automatically restarted by the control plane on failure. If this is null
, any explicitly configured auto-restart policy will be unset, and the control plane will select the default policy when determining whether the instance can be automatically restarted.
Currently, the global default auto-restart policy is "best-effort", so instances with null
auto-restart policies will be automatically restarted. However, in the future, the default policy may be configurable through other mechanisms, such as on a per-project basis. In that case, any configured default policy will be used if this is null
.
A policy determining when an instance should be automatically restarted by the control plane.
Name or ID of the disk the instance should be instructed to boot from.
If not provided, unset the instance's boot disk.
The amount of memory to assign to this instance.
Byte count to express memory or storage capacity.
The number of CPUs to assign to this instance.
The number of CPUs in an Instance
Responses
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.
true
if this instance's auto-restart policy will permit the control plane to automatically restart it if it enters the Failed
state.
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.
the ID of the disk used to boot this Instance, if a specific one is assigned.
human-readable free-form text about a resource
RFC1035-compliant hostname for the Instance.
unique, immutable, system-controlled identifier for each resource
memory allocated for this Instance
Byte count to express memory or storage capacity.
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.
number of CPUs allocated for this Instance
The number of CPUs in an Instance
id for the project containing this Instance
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
timestamp when this resource was created
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.
timestamp when this resource was last modified