REST Resource: instances

Resource: 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.

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "tags": {
    "items": [
      string
    ],
    "fingerprint": string
  },
  "machineType": string,
  "status": enum,
  "statusMessage": string,
  "zone": string,
  "canIpForward": boolean,
  "networkInterfaces": [
    {
      "network": string,
      "subnetwork": string,
      "networkIP": string,
      "ipv6Address": string,
      "name": string,
      "accessConfigs": [
        {
          "type": enum,
          "name": string,
          "natIP": string,
          "setPublicPtr": boolean,
          "publicPtrDomainName": string,
          "networkTier": enum,
          "kind": string
        }
      ],
      "aliasIpRanges": [
        {
          "ipCidrRange": string,
          "subnetworkRangeName": string
        }
      ],
      "fingerprint": string,
      "nicType": enum,
      "kind": string
    }
  ],
  "disks": [
    {
      "type": enum,
      "mode": enum,
      "source": string,
      "deviceName": string,
      "index": integer,
      "boot": boolean,
      "initializeParams": {
        "diskName": string,
        "sourceImage": string,
        "diskSizeGb": string,
        "diskType": string,
        "sourceImageEncryptionKey": {
          "rawKey": string,
          "rsaEncryptedKey": string,
          "kmsKeyName": string,
          "sha256": string,
          "kmsKeyServiceAccount": string
        },
        "labels": {
          string: string,
          ...
        },
        "sourceSnapshot": string,
        "sourceSnapshotEncryptionKey": {
          "rawKey": string,
          "rsaEncryptedKey": string,
          "kmsKeyName": string,
          "sha256": string,
          "kmsKeyServiceAccount": string
        },
        "description": string,
        "guestOsFeatures": [
          {
            "type": enum
          }
        ],
        "resourcePolicies": [
          string
        ],
        "onUpdateAction": enum,
        "provisionedIops": string,
        "multiWriter": boolean
      },
      "autoDelete": boolean,
      "licenses": [
        string
      ],
      "interface": enum,
      "guestOsFeatures": [
        {
          "type": enum
        }
      ],
      "diskEncryptionKey": {
        "sha256": string,
        "kmsKeyServiceAccount": string,

        
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string
        
      },
      "diskSizeGb": string,
      "shieldedInstanceInitialState": {
        "pk": {
          "content": string,
          "fileType": enum
        },
        "keks": [
          {
            "content": string,
            "fileType": enum
          }
        ],
        "dbs": [
          {
            "content": string,
            "fileType": enum
          }
        ],
        "dbxs": [
          {
            "content": string,
            "fileType": enum
          }
        ]
      },
      "kind": string
    }
  ],
  "metadata": {
    "fingerprint": string,
    "items": [
      {
        "key": string,
        "value": string
      }
    ],
    "kind": string
  },
  "serviceAccounts": [
    {
      "email": string,
      "scopes": [
        string
      ]
    }
  ],
  "selfLink": string,
  "scheduling": {
    "onHostMaintenance": enum,
    "automaticRestart": boolean,
    "preemptible": boolean,
    "nodeAffinities": [
      {
        "key": string,
        "operator": enum,
        "values": [
          string
        ]
      }
    ],
    "minNodeCpus": integer,
    "locationHint": string
  },
  "cpuPlatform": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "minCpuPlatform": string,
  "guestAccelerators": [
    {
      "acceleratorType": string,
      "acceleratorCount": integer
    }
  ],
  "startRestricted": boolean,
  "deletionProtection": boolean,
  "resourcePolicies": [
    string
  ],
  "sourceMachineImage": string,
  "shieldedVmConfig": {
    "enableSecureBoot": boolean,
    "enableVtpm": boolean,
    "enableIntegrityMonitoring": boolean
  },
  "shieldedVmIntegrityPolicy": {
    "updateAutoLearnPolicy": boolean
  },
  "reservationAffinity": {
    "consumeReservationType": enum,
    "key": string,
    "values": [
      string
    ]
  },
  "hostname": string,
  "displayDevice": {
    "enableDisplay": boolean
  },
  "shieldedInstanceConfig": {
    "enableSecureBoot": boolean,
    "enableVtpm": boolean,
    "enableIntegrityMonitoring": boolean
  },
  "shieldedInstanceIntegrityPolicy": {
    "updateAutoLearnPolicy": boolean
  },
  "sourceMachineImageEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "eraseWindowsVssSignature": boolean,
  "confidentialInstanceConfig": {
    "enableConfidentialCompute": boolean
  },
  "fingerprint": string,
  "privateIpv6GoogleAccess": enum,
  "advancedMachineFeatures": {
    "enableNestedVirtualization": boolean
  },
  "lastStartTimestamp": string,
  "lastStopTimestamp": string,
  "lastSuspendedTimestamp": string,
  "satisfiesPzs": boolean,
  "networkPerformanceConfig": {
    "totalEgressBandwidthTier": enum
  },
  "kind": string
}
Fields
id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
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.
description

string

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

object

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.
tags.items[]

string

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
tags.fingerprint

string (bytes format)

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.

A base64-encoded string.
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.
status

enum

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

string

[Output Only] An optional, human-readable explanation of the status.
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.
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.
networkInterfaces[]

object

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

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:

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

string

[Output Only] An IPv6 internal network address for this network interface.
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[].accessConfigs[]

object

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
networkInterfaces[].accessConfigs[].type

enum

The type of configuration. The default and only option is ONE_TO_ONE_NAT.
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[].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[].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[].networkTier

enum

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

string

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

object

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
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

string (bytes format)

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.

A base64-encoded string.
networkInterfaces[].nicType

enum

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
networkInterfaces[].kind

string

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

object

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

enum

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

enum

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 initializeParams.sourceSnapshot 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[].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[].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[].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[].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.diskName

string

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
disks[].initializeParams.sourceImage

string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot 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.diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 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:

Note that for InstanceTemplate, this is the name of the disk type, not URL.
disks[].initializeParams.sourceImageEncryptionKey

object

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
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.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.
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.sourceImageEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
disks[].initializeParams.labels

map (key: string, 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
disks[].initializeParams.sourceSnapshot

string

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage 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

The customer-supplied encryption key of the source snapshot.
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.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.
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[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
disks[].initializeParams.description

string

An optional description. Provide this property when creating the disk.
disks[].initializeParams.guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
disks[].initializeParams.guestOsFeatures[].type

enum

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
disks[].initializeParams.resourcePolicies[]

string

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
disks[].initializeParams.onUpdateAction

enum

Specifies which action to take on instance update with this disk. Default is to use the existing disk.
disks[].initializeParams.provisionedIops

string (int64 format)

Indicates how many IOPS must be provisioned for the disk.
disks[].initializeParams.multiWriter

boolean

Indicates whether or not the disk can be read/write attached to more than one instance.
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[].licenses[]

string

[Output Only] Any valid publicly visible licenses.
disks[].interface

enum

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.
disks[].guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
disks[].guestOsFeatures[].type

enum

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

object

Encrypts or decrypts a disk using a customer-supplied encryption key.

If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
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.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
disks[].diskEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.
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[].diskEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
disks[].diskSizeGb

string (int64 format)

The size of the disk in GB.
disks[].shieldedInstanceInitialState

object

[Output Only] shielded vm initial state stored on disk
disks[].shieldedInstanceInitialState.pk

object

The Platform Key (PK).
disks[].shieldedInstanceInitialState.pk.content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
disks[].shieldedInstanceInitialState.pk.fileType

enum

The file type of source file.
disks[].shieldedInstanceInitialState.keks[]

object

The Key Exchange Key (KEK).
disks[].shieldedInstanceInitialState.keks[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
disks[].shieldedInstanceInitialState.keks[].fileType

enum

The file type of source file.
disks[].shieldedInstanceInitialState.dbs[]

object

The Key Database (db).
disks[].shieldedInstanceInitialState.dbs[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
disks[].shieldedInstanceInitialState.dbs[].fileType

enum

The file type of source file.
disks[].shieldedInstanceInitialState.dbxs[]

object

The forbidden key database (dbx).
disks[].shieldedInstanceInitialState.dbxs[].content

string (bytes format)

The raw content in the secure keys file.

A base64-encoded string.
disks[].shieldedInstanceInitialState.dbxs[].fileType

enum

The file type of source file.
disks[].kind

string

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

object

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

string (bytes format)

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.

A base64-encoded string.
metadata.items[]

object

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
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.
serviceAccounts[]

object

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.
serviceAccounts[].email

string

Email address of the service account.
serviceAccounts[].scopes[]

string

The list of scopes to be made available for this service account.
scheduling

object

Sets the scheduling options for this instance.
scheduling.onHostMaintenance

enum

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

boolean

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.
scheduling.nodeAffinities[]

object

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
scheduling.nodeAffinities[].key

string

Corresponds to the label key of Node resource.
scheduling.nodeAffinities[].operator

enum

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
scheduling.nodeAffinities[].values[]

string

Corresponds to the label values of Node resource.
scheduling.minNodeCpus

integer

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
scheduling.locationHint

string

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
cpuPlatform

string

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

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labelFingerprint

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.
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".
guestAccelerators[]

object

A list of the type and count of accelerator cards attached to the 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.
guestAccelerators[].acceleratorCount

integer

The number of the guest accelerator cards exposed to this instance.
startRestricted

boolean

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

boolean

Whether the resource should be protected against deletion.
resourcePolicies[]

string

Resource policies applied to this instance.
sourceMachineImage

string

Source machine image
shieldedVmConfig

object

Deprecating, please use shieldedInstanceConfig.
shieldedVmConfig.enableSecureBoot

boolean

Defines whether the instance has Secure Boot enabled.
shieldedVmConfig.enableVtpm

boolean

Defines whether the instance has the vTPM enabled.
shieldedVmConfig.enableIntegrityMonitoring

boolean

Defines whether the instance has integrity monitoring enabled.
shieldedVmIntegrityPolicy

object

Deprecating, please use shieldedInstanceIntegrityPolicy.
shieldedVmIntegrityPolicy.updateAutoLearnPolicy

boolean

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

object

Specifies the reservations that this instance can consume from.
reservationAffinity.consumeReservationType

enum

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

Corresponds to the label values of a reservation resource.
hostname

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

object

Enables display device for the instance.
displayDevice.enableDisplay

boolean

Defines whether the instance has Display enabled.
shieldedInstanceConfig

object
shieldedInstanceConfig.enableSecureBoot

boolean

Defines whether the instance has Secure Boot enabled. Disabled by default.
shieldedInstanceConfig.enableVtpm

boolean

Defines whether the instance has the vTPM enabled. Enabled by default.
shieldedInstanceConfig.enableIntegrityMonitoring

boolean

Defines whether the instance has integrity monitoring enabled. Enabled by default.
shieldedInstanceIntegrityPolicy

object
shieldedInstanceIntegrityPolicy.updateAutoLearnPolicy

boolean

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

object

Source GMI encryption key when creating an instance from GMI.
sourceMachineImageEncryptionKey.rawKey

string

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

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at: 
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceMachineImageEncryptionKey.kmsKeyName

string

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

string

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

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
eraseWindowsVssSignature

boolean

Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.
confidentialInstanceConfig

object
confidentialInstanceConfig.enableConfidentialCompute

boolean

Defines whether the instance should have confidential compute enabled.
fingerprint

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

enum

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
advancedMachineFeatures

object

Controls for advanced machine-related behavior features.
advancedMachineFeatures.enableNestedVirtualization

boolean

Whether to enable nested virtualization or not (default is false).
lastStartTimestamp

string

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

string

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

string

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

boolean

[Output Only] Reserved for future use.
networkPerformanceConfig

object
networkPerformanceConfig.totalEgressBandwidthTier

enum
satisfiesPzs

boolean

[Output Only] Reserved for future use.
networkPerformanceConfig

object
networkPerformanceConfig.totalEgressBandwidthTier

enum
kind

string

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

Methods

addAccessConfig

 Adds an access config to an instance's network interface.

addResourcePolicies

 Adds existing resource policies to an instance.

aggregatedList

 Retrieves aggregated list of all of the instances in your project across all regions and zones.

attachDisk

 Attaches an existing Disk resource to an instance.

delete

 Deletes the specified Instance resource.