Compute Engine v1 API - Class Instance (2.6.0)

Reference documentation and code samples for the Compute Engine v1 API class Instance.

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Controls for advanced machine-related behavior features.

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 .

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

[Output Only] Creation timestamp in RFC3339 text format.

Whether the resource should be protected against deletion.

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

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

Enables display device for the instance.

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 list of the type and count of accelerator cards attached to the instance.

Gets whether the "can_ip_forward" field is set

Gets whether the "cpu_platform" field is set

Gets whether the "creation_timestamp" field is set

Gets whether the "deletion_protection" field is set

Gets whether the "description" field is set

Gets whether the "fingerprint" field is set

Gets whether the "hostname" field is set

Gets whether the "id" field is set

Gets whether the "key_revocation_action_type" field is set

Gets whether the "kind" field is set

Gets whether the "label_fingerprint" field is set

Gets whether the "last_start_timestamp" field is set

Gets whether the "last_stop_timestamp" field is set

Gets whether the "last_suspended_timestamp" field is set

Gets whether the "machine_type" field is set

Gets whether the "min_cpu_platform" field is set

Gets whether the "name" field is set

Gets whether the "private_ipv6_google_access" field is set

Gets whether the "satisfies_pzs" field is set

Gets whether the "self_link" field is set

Gets whether the "source_machine_image" field is set

Gets whether the "start_restricted" field is set

Gets whether the "status" field is set

Gets whether the "status_message" field is set

Gets whether the "zone" field is set

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.

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

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

[Output Only] Type of the resource. Always compute#instance for instances.

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.

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

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

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

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

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.

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

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".

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.

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.

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

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

Specifies the reservations that this instance can consume from.

Resource policies applied to this instance.

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

[Output Only] Reserved for future use.

Sets the scheduling options for this instance.

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

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.

Source machine image

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

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

[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. Check the Status enum for the list of possible values.

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

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.

[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.