project STRING Required

Project ID for this request

zone STRING Required

The name of the zone for this request

instance STRING Required

Name of the instance resource to return

canIpForward 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

cpuPlatform STRING

[Output Only] The CPU platform used by this instance

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

deletionProtection BOOLEAN

Whether the resource should be protected against deletion

description STRING

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

disks[] OBJECT

An instance-attached disk resource

disks[].autoDelete BOOLEAN

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)

disks[].boot BOOLEAN

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem

disks[].deviceName STRING

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks

disks[].diskEncryptionKey OBJECT

Represents a customer-supplied encryption key

disks[].diskEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

disks[].diskEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

disks[].diskEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

disks[].guestOsFeatures[] OBJECT

Guest OS features

disks[].guestOsFeatures[].type ENUMERATION

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options

disks[].index INTEGER

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number

disks[].initializeParams OBJECT

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both

disks[].initializeParams.description STRING

An optional description. Provide this property when creating the disk

disks[].initializeParams.diskName STRING

Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated

disks[].initializeParams.diskSizeGb INTEGER

Specifies the size of the disk in base-2 GB

disks[].initializeParams.diskType STRING

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

• https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
• projects/project/zones/zone/diskTypes/diskType
• zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

disks[].initializeParams.labels OBJECT

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

disks[].initializeParams.labels.customKey.value STRING

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

disks[].initializeParams.resourcePolicies[] STRING

disks[].initializeParams.sourceImage STRING

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9

Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image

You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

If the source image is deleted later, this field will not be set

disks[].initializeParams.sourceImageEncryptionKey OBJECT

Represents a customer-supplied encryption key

disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

disks[].initializeParams.sourceImageEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

disks[].initializeParams.sourceImageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

disks[].initializeParams.sourceSnapshot STRING

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD.

To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup

If the source snapshot is deleted later, this field will not be set

disks[].initializeParams.sourceSnapshotEncryptionKey OBJECT

Represents a customer-supplied encryption key

disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

disks[].initializeParams.sourceSnapshotEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

disks[].initializeParams.sourceSnapshotEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

disks[].interface ENUMERATION

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported

disks[].kind STRING

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks

disks[].licenses[] STRING

disks[].mode ENUMERATION

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode

disks[].source STRING

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk

disks[].type ENUMERATION

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT

guestAccelerators[] OBJECT

A specification of the type and number of accelerator cards attached to the instance

guestAccelerators[].acceleratorCount INTEGER

The number of the guest accelerator cards exposed to this instance

guestAccelerators[].acceleratorType STRING

Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types

hostname STRING

id INTEGER

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

kind STRING

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

labelFingerprint BINARY

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 OBJECT

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

labels.customKey.value STRING

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

machineType 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

metadata OBJECT

A metadata key/value entry

metadata.fingerprint BINARY

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

To see the latest fingerprint, make a get() request to retrieve the resource

metadata.items[] OBJECT

metadata.items[].key STRING

Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project

metadata.items[].value STRING

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB)

metadata.kind STRING

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

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

name 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

networkInterfaces[] OBJECT

A network interface resource attached to an instance

networkInterfaces[].accessConfigs[] OBJECT

An access configuration attached to an instance's network interface. Only one access config per instance is supported

networkInterfaces[].accessConfigs[].kind STRING

[Output Only] Type of the resource. Always compute#accessConfig for access configs

networkInterfaces[].accessConfigs[].name STRING

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access

networkInterfaces[].accessConfigs[].natIP STRING

An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance

networkInterfaces[].accessConfigs[].networkTier ENUMERATION

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP

networkInterfaces[].accessConfigs[].publicPtrDomainName STRING

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled

networkInterfaces[].accessConfigs[].setPublicPtr BOOLEAN

Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name

networkInterfaces[].accessConfigs[].type ENUMERATION

The type of configuration. The default and only option is ONE_TO_ONE_NAT

networkInterfaces[].aliasIpRanges[] OBJECT

An alias IP range attached to an instance's network interface

networkInterfaces[].aliasIpRanges[].ipCidrRange STRING

The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24)

networkInterfaces[].aliasIpRanges[].subnetworkRangeName STRING

The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used

networkInterfaces[].fingerprint BINARY

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet

networkInterfaces[].kind STRING

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces

networkInterfaces[].name STRING

[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc

networkInterfaces[].network STRING

URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

• https://www.googleapis.com/compute/v1/projects/project/global/networks/network
• projects/project/global/networks/network
• global/networks/default

networkInterfaces[].networkIP STRING

An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system

networkInterfaces[].subnetwork STRING

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

• https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
• regions/region/subnetworks/subnetwork

reservationAffinity OBJECT

Specifies the reservations that this instance can consume from

reservationAffinity.consumeReservationType ENUMERATION

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples

reservationAffinity.key STRING

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value

reservationAffinity.values[] STRING

scheduling OBJECT

Sets the scheduling options for an Instance. NextID: 9

scheduling.automaticRestart BOOLEAN

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine

scheduling.nodeAffinities[] OBJECT

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled

scheduling.nodeAffinities[].key STRING

Corresponds to the label key of Node resource

scheduling.nodeAffinities[].operator ENUMERATION

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity

scheduling.nodeAffinities[].values[] STRING

scheduling.onHostMaintenance ENUMERATION

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options

scheduling.preemptible BOOLEAN

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created

selfLink STRING

[Output Only] Server-defined URL for this resource

serviceAccounts[] OBJECT

A service account

serviceAccounts[].email STRING

Email address of the service account

serviceAccounts[].scopes[] STRING

shieldedInstanceConfig OBJECT

A set of Shielded Instance options

shieldedInstanceConfig.enableIntegrityMonitoring BOOLEAN

Defines whether the instance has integrity monitoring enabled

shieldedInstanceConfig.enableSecureBoot BOOLEAN

Defines whether the instance has Secure Boot enabled

shieldedInstanceConfig.enableVtpm BOOLEAN

Defines whether the instance has the vTPM enabled

shieldedInstanceIntegrityPolicy OBJECT

The policy describes the baseline against which Instance boot integrity is measured

shieldedInstanceIntegrityPolicy.updateAutoLearnPolicy BOOLEAN

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

startRestricted BOOLEAN

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

status ENUMERATION

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED

statusMessage STRING

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

tags OBJECT

A set of instance tags

tags.fingerprint BINARY

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

To see the latest fingerprint, make get() request to the instance

tags.items[] STRING

zone 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