REST Resource: instances

string

[Output Only] Type of the resource. Always

compute#instance

for instances.

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

string

[Output Only] Creation timestamp in RFC3339 text format.

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

string

An optional description of this resource. Provide this property when you create the resource.

object (Tags)

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

string

Full or partial URL of the machine type resource to use for this instance, in the format:

zones/zone/machineTypes/machine-type

. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

zones/us-central1-f/machineTypes/n1-standard-1

To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

zones/zone/machineTypes/custom-CPUS-MEMORY

For example:

zones/us-central1-f/machineTypes/custom-4-5120

For a full list of restrictions, read the Specifications for custom machine types.

enum (Status)

[Output Only] The status of the instance. One of the following values:

PROVISIONING

,

STAGING

,

RUNNING

,

STOPPING

,

SUSPENDING

,

SUSPENDED

,

REPAIRING

, and

TERMINATED

. For more information about the status of the instance, see Instance life cycle.

string

[Output Only] An optional, human-readable explanation of the status.

string

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

boolean

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

object (NetworkInterface)

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

object (AttachedDisk)

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

object (Metadata)

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

object (ServiceAccount)

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

string

[Output Only] Server-defined URL for this resource.

object (Scheduling)

Sets the scheduling options for this instance.

string

[Output Only] The CPU platform used by this instance.

map (key: string, value: string)

Labels to apply to this instance. These can be later modified by the

setLabels

method.

object (InstanceParams)

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

string (bytes format)

A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make

get()

request to the instance.

A base64-encoded string.

object (CustomerEncryptionKey)

Encrypts suspended data for an instance with a customer-managed encryption key.

If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation.

If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

string

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as

minCpuPlatform: "Intel Haswell"

or

minCpuPlatform: "Intel Sandy Bridge"

.

object (AcceleratorConfig)

A list of the type and count of accelerator cards attached to the instance.

boolean

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

boolean

Whether the resource should be protected against deletion.

string

Resource policies applied to this instance.

string

Source machine image

object (ReservationAffinity)

Specifies the reservations that this instance can consume from.

string

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

object (DisplayDevice)

Enables display device for the instance.

object (ShieldedInstanceConfig)

object (ShieldedInstanceIntegrityPolicy)

object (CustomerEncryptionKey)

Source machine image encryption key when creating an instance from a machine image.

object (ConfidentialInstanceConfig)

string (bytes format)

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

To see the latest fingerprint, make

get()

request to the instance.

A base64-encoded string.

enum (InstancePrivateIpv6GoogleAccess)

The private IPv6 google access type for the VM. If not specified, use

INHERIT_FROM_SUBNETWORK

as default.

object (AdvancedMachineFeatures)

Controls for advanced machine-related behavior features.

string

[Output Only] Last start timestamp in RFC3339 text format.

string

[Output Only] Last stop timestamp in RFC3339 text format.

string

[Output Only] Last suspended timestamp in RFC3339 text format.

boolean

[Output Only] Reserved for future use.

boolean

[Output Only] Reserved for future use.

object (ResourceStatus)

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

object (NetworkPerformanceConfig)

enum (KeyRevocationActionType)

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

map (key: string, value: string)

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

boolean

Defines whether the instance has Display enabled.

boolean

Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

object (Scheduling)

object (UpcomingMaintenance)

string

[Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId/subBlockId/hostId.

integer

Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

enum (MaintenanceType)

Defines the type of maintenance.

boolean

Indicates if the maintenance can be customer triggered.

string

The current start time of the maintenance window. This timestamp value is in RFC3339 text format.

string

The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.

string

The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.

enum (MaintenanceStatus)