Instances

Represents an Instance resource. See the Instance documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

An Instance resource.

{
  "kind": "compute#instance",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "tags": {
    "items": [
      string
    ],
    "fingerprint": bytes
  },
  "machineType": string,
  "status": string,
  "statusMessage": string,
  "zone": string,
  "canIpForward": boolean,
  "networkInterfaces": [
    {
      "kind": "compute#networkInterface",
      "network": string,
      "subnetwork": string,
      "networkIP": string,
      "name": string,
      "accessConfigs": [
        {
          "kind": "compute#accessConfig",
          "type": string,
          "name": string,
          "natIP": string
        }
      ]
    }
  ],
  "disks": [
    {
      "kind": "compute#attachedDisk",
      "type": string,
      "mode": string,
      "source": string,
      "deviceName": string,
      "index": integer,
      "boot": boolean,
      "initializeParams": {
        "diskName": string,
        "sourceImage": string,
        "diskSizeGb": long,
        "diskType": string,
        "sourceImageEncryptionKey": {
          "rawKey": string,
          "sha256": string
        }
      },
      "autoDelete": boolean,
      "licenses": [
        string
      ],
      "interface": string,
      "diskEncryptionKey": {
        "rawKey": string,
        "sha256": string
      }
    }
  ],
  "metadata": {
    "kind": "compute#metadata",
    "fingerprint": bytes,
    "items": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "serviceAccounts": [
    {
      "email": string,
      "scopes": [
        string
      ]
    }
  ],
  "selfLink": string,
  "scheduling": {
    "onHostMaintenance": string,
    "automaticRestart": boolean,
    "preemptible": boolean
  },
  "cpuPlatform": string
}
Property name Value Description Notes
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.
description string An optional description of this resource. Provide this property when you create the resource.
disks[] list Array of disks associated with this instance. Persistent disks must be created before you can assign them.
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-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
disks[].diskEncryptionKey nested 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.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
disks[].index integer Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
disks[].initializeParams nested 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.
disks[].initializeParams.diskSizeGb long 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.sourceImage string The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

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

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private 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-private-family

If the source image is deleted later, this field will not be set.
disks[].initializeParams.sourceImageEncryptionKey nested 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.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
disks[].interface string 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[].kind string [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
disks[].licenses[] list [Output Only] Any valid publicly visible licenses.
disks[].mode string 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.

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 string Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
id unsigned long [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.
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 nested object The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
metadata.fingerprint bytes 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.
metadata.items[] list 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 32768 bytes.
metadata.kind string [Output Only] Type of the resource. Always compute#metadata for metadata.
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[] list An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
networkInterfaces[].accessConfigs[] list 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[].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 you would like. For example, 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[].type string The type of configuration. The default and only option is ONE_TO_ONE_NAT.
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, 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.

This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used.

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 network 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 provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, 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
scheduling nested object Sets the scheduling options for this instance.
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.onHostMaintenance string 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.
serviceAccounts[] list 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[] list The list of scopes to be made available for this service account.
status string [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
statusMessage string [Output Only] An optional, human-readable explanation of the status.
tags nested object A list of 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.
tags.fingerprint bytes 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.

To see the latest fingerprint, make get() request to the instance.
tags.items[] list An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
zone string [Output Only] URL of the zone where the instance resides.

Methods

The following are valid Instance resource methods:

addAccessConfig
Adds an access config to an instance's network interface.
aggregatedList
Retrieves aggregated list of instances.
attachDisk
Attaches a Disk resource to an instance.
delete
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
deleteAccessConfig
Deletes an access config from an instance's network interface.
detachDisk
Detaches a disk from an instance.
get
Returns the specified Instance resource. Get a list of available instances by making a list() request.
getSerialPortOutput
Returns the specified instance's serial port output.
insert
Creates an instance resource in the specified project using the data included in the request.
list
Retrieves the list of instances contained within the specified zone.
reset
Performs a reset on the instance. For more information, see Resetting an instance.
setDiskAutoDelete
Sets the auto-delete flag for a disk attached to an instance.
setMachineType
Changes the machine type for a stopped instance to the machine type specified in the request.
setMetadata
Sets metadata for the specified instance to the data included in the request.
setScheduling
Sets an instance's scheduling options.
setServiceAccount
Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.
setTags
Sets tags for the specified instance to the data included in the request.
start
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
startWithEncryptionKey
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
stop
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Send feedback about...

Compute Engine