REST Resource: instances

Resource: Instance
- JSON representation
Methods

Resource: Instance

An Instance resource.

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, "name": string, "accessConfigs": { "type": enum, "name": string, "natIP": string, "setPublicPtr": boolean, "publicPtrDomainName": string, "kind": string }, "aliasIpRanges": { "ipCidrRange": string, "subnetworkRangeName": string }, "kind": string } ], "disks": [ { "type": enum, "mode": enum, "source": string, "deviceName": string, "index": number, "boot": boolean, "initializeParams": { "diskName": string, "sourceImage": string, "diskSizeGb": string, "diskType": string, "sourceImageEncryptionKey": { "rawKey": string, "sha256": string }, "labels": { string: string, ... } }, "autoDelete": boolean, "licenses": string, "interface": enum, "guestOsFeatures": { "type": enum }, "diskEncryptionKey": { "sha256": string, "rawKey": string }, "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 }, "cpuPlatform": string, "labels": { string: string, ... }, "labelFingerprint": string, "minCpuPlatform": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": number } ], "startRestricted": boolean, "deletionProtection": boolean, "kind": string }

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,
      "name": string,
      "accessConfigs": {
        "type": enum,
        "name": string,
        "natIP": string,
        "setPublicPtr": boolean,
        "publicPtrDomainName": string,
        "kind": string
      },
      "aliasIpRanges": {
        "ipCidrRange": string,
        "subnetworkRangeName": string
      },
      "kind": string
    }
  ],
  "disks": [
    {
      "type": enum,
      "mode": enum,
      "source": string,
      "deviceName": string,
      "index": number,
      "boot": boolean,
      "initializeParams": {
        "diskName": string,
        "sourceImage": string,
        "diskSizeGb": string,
        "diskType": string,
        "sourceImageEncryptionKey": {
          "rawKey": string,
          "sha256": string
        },
        "labels": {
          string: string,
          ...
        }
      },
      "autoDelete": boolean,
      "licenses": string,
      "interface": enum,
      "guestOsFeatures": {
        "type": enum
      },
      "diskEncryptionKey": {
        "sha256": string,
        "rawKey": string
      },
      "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
  },
  "cpuPlatform": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "minCpuPlatform": string,
  "guestAccelerators": [
    {
      "acceleratorType": string,
      "acceleratorCount": number
    }
  ],
  "startRestricted": boolean,
  "deletionProtection": boolean,
  "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` 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.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`, `STOPPED`, `SUSPENDING`, `SUSPENDED`, and `TERMINATED`.
`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. 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[].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`
`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[].name`	`string` [Output Only] The name of the network interface, 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 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[].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. This field can only be set when the setPublicPtr field is enabled.
`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. Can only be specified for network interfaces on subnet-mode networks.
`networkInterfaces[].aliasIpRanges[].ipCidrRange`	`string` The IP CIDR range represented by this alias IP range. 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 (e.g. `10.2.3.4`), a netmask (e.g. `/24`) or a CIDR format string (e.g. `10.1.2.0/24`).
`networkInterfaces[].aliasIpRanges[].subnetworkRangeName`	`string` Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
`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 `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-disks-x`, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
`disks[].index`	`number` [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.
`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-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 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.
`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.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.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`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[].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.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`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. 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.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`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, it cannot be set or changed after the instance has been created.
`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. If you are creating an instance template, specify only the accelerator name.
`guestAccelerators[].acceleratorCount`	`number` 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.
`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.
`aggregatedList`	Retrieves aggregated list of instances.
`attachDisk`	Attaches an existing Disk resource to an instance.
`delete`	Deletes the specified Instance resource.
`deleteAccessConfig`	Deletes an access config from an instance's network interface.
`detachDisk`	Detaches a disk from an instance.
`get`	Returns the specified Instance resource.
`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.
`listReferrers`	Retrieves the list of referrers to instances contained within the specified zone.
`reset`	Performs a reset on the instance.
`setDeletionProtection`	Sets deletion protection on the instance.
`setDiskAutoDelete`	Sets the auto-delete flag for a disk attached to an instance.
`setLabels`	Sets labels on an instance.
`setMachineResources`	Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
`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.
`setMinCpuPlatform`	Changes the minimum CPU platform that this instance should use.
`setScheduling`	Sets an instance's scheduling options.
`setServiceAccount`	Sets the service account on the instance.
`setTags`	Sets tags for the specified instance to the data included in the request.
`simulateMaintenanceEvent`	Simulates a maintenance event on the instance.
`start`	Starts an instance that was stopped using the `instances().stop` method.
`startWithEncryptionKey`	Starts an instance that was stopped using the `instances().stop` method.
`stop`	Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.
`testIamPermissions`	Returns permissions that a caller has on the specified resource.
`updateAccessConfig`	Updates the specified access config from an instance's network interface with the data included in the request.
`updateNetworkInterface`	Updates an instance's network interface.

Resource: Instance

Methods

`addAccessConfig`

`aggregatedList`

`attachDisk`

`delete`

`deleteAccessConfig`

`detachDisk`

`get`

`getSerialPortOutput`

`insert`

`list`

`listReferrers`

`reset`

`setDeletionProtection`

`setDiskAutoDelete`

`setLabels`

`setMachineResources`

`setMachineType`

`setMetadata`

`setMinCpuPlatform`

`setScheduling`

`setServiceAccount`

`setTags`

`simulateMaintenanceEvent`

`start`

`startWithEncryptionKey`

`stop`

`testIamPermissions`

`updateAccessConfig`

`updateNetworkInterface`

Send feedback about...