project STRING Required

Project ID 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

An object that contains a list of instances scoped by zone

items.customKey OBJECT

Add additional named properties

items.customKey.instances[] 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.customKey.instances[].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.customKey.instances[].cpuPlatform STRING

[Output Only] The CPU platform used by this instance

items.customKey.instances[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items.customKey.instances[].deletionProtection BOOLEAN

Whether the resource should be protected against deletion

items.customKey.instances[].description STRING

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

items.customKey.instances[].hostname STRING

items.customKey.instances[].id INTEGER

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

items.customKey.instances[].kind STRING

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

items.customKey.instances[].labelFingerprint BINARY

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

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

items.customKey.instances[].labels OBJECT

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

items.customKey.instances[].labels.customKey.value STRING

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

items.customKey.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

items.customKey.instances[].metadata OBJECT

A metadata key/value entry

items.customKey.instances[].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.customKey.instances[].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.customKey.instances[].reservationAffinity OBJECT

Specifies the reservations that this instance can consume from

items.customKey.instances[].scheduling OBJECT

Sets the scheduling options for an Instance. NextID: 9

items.customKey.instances[].selfLink STRING

[Output Only] Server-defined URL for this resource

items.customKey.instances[].shieldedInstanceConfig OBJECT

A set of Shielded Instance options

items.customKey.instances[].shieldedInstanceIntegrityPolicy OBJECT

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

items.customKey.instances[].startRestricted BOOLEAN

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

items.customKey.instances[].status ENUMERATION

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

items.customKey.instances[].statusMessage STRING

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

items.customKey.instances[].tags OBJECT

A set of instance tags

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

items.customKey.warning OBJECT

[Output Only] Informational warning which replaces the list of instances when the list is empty

items.customKey.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

items.customKey.warning.data[] OBJECT

items.customKey.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)

items.customKey.warning.data[].value STRING

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

items.customKey.warning.message STRING

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

kind STRING

[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated 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