project STRING Required

Project ID for this request

zone STRING Required

The name of the zone for this request

filter STRING

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items[] OBJECT

Represents an Instance resource.

An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==)

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

items[].cpuPlatform STRING

[Output Only] The CPU platform used by this instance

items[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items[].deletionProtection BOOLEAN

Whether the resource should be protected against deletion

items[].description STRING

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

items[].disks[] OBJECT

An instance-attached disk resource

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

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

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

items[].disks[].diskEncryptionKey OBJECT

Represents a customer-supplied encryption key

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

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

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

items[].disks[].kind STRING

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

items[].disks[].licenses[] STRING

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

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

items[].disks[].type ENUMERATION

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

items[].guestAccelerators[] OBJECT

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

items[].guestAccelerators[].acceleratorCount INTEGER

The number of the guest accelerator cards exposed to this instance

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

items[].hostname STRING

items[].id INTEGER

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

items[].kind STRING

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

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

items[].labels OBJECT

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

items[].labels.customKey.value STRING

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

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

items[].metadata OBJECT

A metadata key/value entry

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

items[].metadata.items[] OBJECT

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

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

items[].metadata.kind STRING

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

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

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

items[].networkInterfaces[] OBJECT

A network interface resource attached to an instance

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

items[].networkInterfaces[].kind STRING

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

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

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

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

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

items[].reservationAffinity OBJECT

Specifies the reservations that this instance can consume from

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

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

items[].reservationAffinity.values[] STRING

items[].scheduling OBJECT

Sets the scheduling options for an Instance. NextID: 9

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

items[].scheduling.nodeAffinities[] OBJECT

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

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

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

items[].selfLink STRING

[Output Only] Server-defined URL for this resource

items[].serviceAccounts[] OBJECT

A service account

items[].serviceAccounts[].email STRING

Email address of the service account

items[].serviceAccounts[].scopes[] STRING

items[].shieldedInstanceConfig OBJECT

A set of Shielded Instance options

items[].shieldedInstanceConfig.enableIntegrityMonitoring BOOLEAN

Defines whether the instance has integrity monitoring enabled

items[].shieldedInstanceConfig.enableSecureBoot BOOLEAN

Defines whether the instance has Secure Boot enabled

items[].shieldedInstanceConfig.enableVtpm BOOLEAN

Defines whether the instance has the vTPM enabled

items[].shieldedInstanceIntegrityPolicy OBJECT

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

items[].shieldedInstanceIntegrityPolicy.updateAutoLearnPolicy BOOLEAN

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

items[].startRestricted BOOLEAN

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

items[].status ENUMERATION

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

items[].statusMessage STRING

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

items[].tags OBJECT

A set of instance tags

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

items[].tags.items[] STRING

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

kind STRING

[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources

nextPageToken STRING

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code