- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Retrieves the list of instances contained within the specified zone.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
|
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "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": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "labels": { string: string, ... }, "sourceSnapshot": string, "sourceSnapshotEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "description": string, "guestOsFeatures": [ { "type": enum } ], "resourcePolicies": [ string ], "onUpdateAction": enum, "multiWriter": boolean }, "autoDelete": boolean, "licenses": [ string ], "interface": enum, "guestOsFeatures": [ { "type": enum } ], "diskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": 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": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "eraseWindowsVssSignature": boolean, "confidentialInstanceConfig": { "enableConfidentialCompute": boolean }, "fingerprint": string, "privateIpv6GoogleAccess": enum, "advancedMachineFeatures": { "enableNestedVirtualization": boolean }, "lastStartTimestamp": string, "lastStopTimestamp": string, "lastSuspendedTimestamp": string, "kind": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Instance resources. |
items[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
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 |
items[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].tags |
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. |
items[].tags.items[] |
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
items[].tags.fingerprint |
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 A base64-encoded string. |
items[].machineType |
Full or partial URL of the machine type resource to use for this instance, in the format:
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):
For example: |
items[].status |
[Output Only] The status of the instance. One of the following values: |
items[].statusMessage |
[Output Only] An optional, human-readable explanation of the status. |
items[].zone |
[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[].canIpForward |
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[].networkInterfaces[] |
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. |
items[].networkInterfaces[].network |
URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
|
items[].networkInterfaces[].subnetwork |
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:
|
items[].networkInterfaces[].networkIP |
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[].ipv6Address |
[Output Only] An IPv6 internal network address for this network interface. |
items[].networkInterfaces[].name |
[Output Only] The name of the network interface, which is generated by the server. For network devices, these are |
items[].networkInterfaces[].accessConfigs[] |
An array of configurations for this interface. Currently, only one access config, |
items[].networkInterfaces[].accessConfigs[].type |
The type of configuration. The default and only option is |
items[].networkInterfaces[].accessConfigs[].name |
The name of this access configuration. The default and recommended name is |
items[].networkInterfaces[].accessConfigs[].natIP |
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. |
items[].networkInterfaces[].accessConfigs[].setPublicPtr |
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
items[].networkInterfaces[].accessConfigs[].publicPtrDomainName |
The DNS domain name for the public PTR record. You can set this field only if the |
items[].networkInterfaces[].accessConfigs[].networkTier |
This signifies the networking tier used for configuring this access configuration and can only take the following values: 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. |
items[].networkInterfaces[].accessConfigs[].kind |
[Output Only] Type of the resource. Always |
items[].networkInterfaces[].aliasIpRanges[] |
An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
items[].networkInterfaces[].aliasIpRanges[].ipCidrRange |
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 |
items[].networkInterfaces[].aliasIpRanges[].subnetworkRangeName |
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. |
items[].networkInterfaces[].fingerprint |
Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an A base64-encoded string. |
items[].networkInterfaces[].nicType |
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. |
items[].networkInterfaces[].kind |
[Output Only] Type of the resource. Always |
items[].disks[] |
Array of disks associated with this instance. Persistent disks must be created before you can assign them. |
items[].disks[].type |
Specifies the type of the disk, either |
items[].disks[].mode |
The mode in which to attach this disk, either |
items[].disks[].source |
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of 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[].deviceName |
Specifies a unique device name of your choice that is reflected into the If not specified, the server chooses a default device name to apply to this disk, in the form |
items[].disks[].index |
[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[].boot |
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
items[].disks[].initializeParams |
[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 |
items[].disks[].initializeParams.diskName |
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. |
items[].disks[].initializeParams.sourceImage |
The source image to create this disk. When creating a new instance, one of To create a disk with one of the public operating system images, specify the image by its family name. For example, specify
Alternatively, use a specific version of a public operating system image:
To create a disk with a custom image that you created, specify the image name in the following format:
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
If the source image is deleted later, this field will not be set. |
items[].disks[].initializeParams.diskSizeGb |
Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a |
items[].disks[].initializeParams.diskType |
Specifies the disk type to use to create the instance. If not specified, the default is
Other values include
|
items[].disks[].initializeParams.sourceImageEncryptionKey |
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. |
items[].disks[].initializeParams.sourceImageEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKey |
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:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].disks[].initializeParams.sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
items[].disks[].initializeParams.labels |
Labels to apply to this disk. These can be later modified by the An object containing a list of |
items[].disks[].initializeParams.sourceSnapshot |
The source snapshot to create this disk. When creating a new instance, one of To create a disk with a snapshot that you created, specify the snapshot name in the following format:
If the source snapshot is deleted later, this field will not be set. |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey |
The customer-supplied encryption key of the source snapshot. |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey.rsaEncryptedKey |
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:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
items[].disks[].initializeParams.description |
An optional description. Provide this property when creating the disk. |
items[].disks[].initializeParams.guestOsFeatures[] |
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 |
items[].disks[].initializeParams.guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
items[].disks[].initializeParams.resourcePolicies[] |
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. |
items[].disks[].initializeParams.onUpdateAction |
Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
items[].disks[].initializeParams.multiWriter |
Indicates whether or not the disk can be read/write attached to more than one instance. |
items[].disks[].autoDelete |
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[].licenses[] |
[Output Only] Any valid publicly visible licenses. |
items[].disks[].interface |
Specifies the disk interface to use for attaching this disk, which is either |
items[].disks[].guestOsFeatures[] |
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. |
items[].disks[].guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
items[].disks[].diskEncryptionKey |
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. |
items[].disks[].diskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
items[].disks[].diskEncryptionKey.rsaEncryptedKey |
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:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items[].disks[].diskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
items[].disks[].diskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items[].disks[].diskEncryptionKey.kmsKeyServiceAccount |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
items[].disks[].diskSizeGb |
The size of the disk in GB. |
items[].disks[].shieldedInstanceInitialState |
[Output Only] shielded vm initial state stored on disk |
items[].disks[].shieldedInstanceInitialState.pk |
The Platform Key (PK). |
items[].disks[].shieldedInstanceInitialState.pk.content |
The raw content in the secure keys file. A base64-encoded string. |
items[].disks[].shieldedInstanceInitialState.pk.fileType |
The file type of source file. |
items[].disks[].shieldedInstanceInitialState.keks[] |
The Key Exchange Key (KEK). |
items[].disks[].shieldedInstanceInitialState.keks[].content |
The raw content in the secure keys file. A base64-encoded string. |
items[].disks[].shieldedInstanceInitialState.keks[].fileType |
The file type of source file. |
items[].disks[].shieldedInstanceInitialState.dbs[] |
The Key Database (db). |
items[].disks[].shieldedInstanceInitialState.dbs[].content |
The raw content in the secure keys file. A base64-encoded string. |
items[].disks[].shieldedInstanceInitialState.dbs[].fileType |
The file type of source file. |
items[].disks[].shieldedInstanceInitialState.dbxs[] |
The forbidden key database (dbx). |
items[].disks[].shieldedInstanceInitialState.dbxs[].content |
The raw content in the secure keys file. A base64-encoded string. |
items[].disks[].shieldedInstanceInitialState.dbxs[].fileType |
The file type of source file. |
items[].disks[].kind |
[Output Only] Type of the resource. Always |
items[].metadata |
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. |
items[].metadata.fingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
items[].metadata.items[] |
Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
items[].metadata.items[].key |
Key for the metadata entry. Keys must conform to the following regexp: |
items[].metadata.items[].value |
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 |
[Output Only] Type of the resource. Always |
items[].serviceAccounts[] |
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. |
items[].serviceAccounts[].email |
Email address of the service account. |
items[].serviceAccounts[].scopes[] |
The list of scopes to be made available for this service account. |
items[].selfLink |
[Output Only] Server-defined URL for this resource. |
items[].scheduling |
Sets the scheduling options for this instance. |
items[].scheduling.onHostMaintenance |
Defines the maintenance behavior for this instance. For standard instances, the default behavior is |
items[].scheduling.automaticRestart |
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 |
items[].scheduling.preemptible |
Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a |
items[].scheduling.nodeAffinities[] |
A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
items[].scheduling.nodeAffinities[].key |
Corresponds to the label key of Node resource. |
items[].scheduling.nodeAffinities[].operator |
Defines the operation of node selection. Valid operators are |
items[].scheduling.nodeAffinities[].values[] |
Corresponds to the label values of Node resource. |
items[].scheduling.minNodeCpus |
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. |
items[].scheduling.locationHint |
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. |
items[].cpuPlatform |
[Output Only] The CPU platform used by this instance. |
items[].labels |
Labels to apply to this instance. These can be later modified by the An object containing a list of |
items[].labelFingerprint |
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 A base64-encoded string. |
items[].minCpuPlatform |
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as |