- 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
- JSON representation
- JSON representation
- JSON representation
- JSON representation
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves an aggregated list of all of the instances in your project across all regions and zones.
The performance of this method degrades when a filter is specified on a project that has a very large number of instances.
To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/instances
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
Query parameters
| Parameters | |
|---|---|
max |
The maximum number of results per page that should be returned. If the number of available results is larger than |
page |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The 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 If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
order |
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 |
return |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
include |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
service |
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "id": string, "items": { string: { "instances": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "tags": { "items": [ string ], "fingerprint": string }, "machineType": string, "status": enum, "statusMessage": string, "zone": string, "canIpForward": boolean, "networkInterfaces": [ { "kind": string, "network": string, "subnetwork": string, "networkIP": string, "ipv6Address": string, "internalIpv6PrefixLength": integer, "name": string, "accessConfigs": [ { "kind": string, "type": enum, "name": string, "natIP": string, "externalIpv6": string, "externalIpv6PrefixLength": integer, "setPublicPtr": boolean, "publicPtrDomainName": string, "networkTier": enum, "securityPolicy": string } ], "ipv6AccessConfigs": [ { "kind": string, "type": enum, "name": string, "natIP": string, "externalIpv6": string, "externalIpv6PrefixLength": integer, "setPublicPtr": boolean, "publicPtrDomainName": string, "networkTier": enum, "securityPolicy": string } ], "aliasIpRanges": [ { "ipCidrRange": string, "subnetworkRangeName": string } ], "fingerprint": string, "stackType": enum, "ipv6AccessType": enum, "queueCount": integer, "nicType": enum, "networkAttachment": string } ], "disks": [ { "kind": string, "type": enum, "mode": enum, "savedState": enum, "source": string, "deviceName": string, "index": integer, "boot": boolean, "initializeParams": { "diskName": string, "sourceImage": string, "diskSizeGb": string, "diskType": string, "sourceImageEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "labels": { string: string, ... }, "sourceSnapshot": string, "sourceInstantSnapshot": string, "sourceSnapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "description": string, "replicaZones": [ string ], "guestOsFeatures": [ { "type": enum } ], "resourcePolicies": [ string ], "onUpdateAction": enum, "provisionedIops": string, "multiWriter": boolean, "licenses": [ string ], "architecture": enum, "resourceManagerTags": { string: string, ... }, "provisionedThroughput": string, "enableConfidentialCompute": boolean, "storagePool": string }, "autoDelete": boolean, "licenses": [ string ], "interface": enum, "guestOsFeatures": [ { "type": enum } ], "diskEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string }, "diskSizeGb": string, "shieldedInstanceInitialState": { "pk": { "content": string, "fileType": enum }, "keks": [ { "content": string, "fileType": enum } ], "dbs": [ { "content": string, "fileType": enum } ], "dbxs": [ { "content": string, "fileType": enum } ] }, "userLicenses": [ string ], "forceAttach": boolean, "locked": boolean, "architecture": enum } ], "metadata": { "kind": string, "fingerprint": string, "items": [ { "key": string, "value": string } ] }, "serviceAccounts": [ { "email": string, "scopes": [ string ] } ], "selfLink": string, "scheduling": { "maxRunDuration": { "seconds": string, "nanos": integer }, "terminationTime": string, "onInstanceStopAction": { "discardLocalSsd": boolean }, "onHostMaintenance": enum, "automaticRestart": boolean, "preemptible": boolean, "nodeAffinities": [ { "key": string, "operator": enum, "values": [ string ] } ], "minNodeCpus": integer, "locationHint": string, "maintenanceFreezeDurationHours": integer, "maintenanceInterval": enum, "availabilityDomain": integer, "provisioningModel": enum, "instanceTerminationAction": enum, "hostErrorTimeoutSeconds": integer, "gracefulShutdown": { "enabled": boolean, "maxDuration": { "seconds": string, "nanos": integer } }, "localSsdRecoveryTimeout": { "seconds": string, "nanos": integer } }, "cpuPlatform": string, "labels": { string: string, ... }, "params": { "resourceManagerTags": { string: string, ... } }, "labelFingerprint": string, "instanceEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": 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": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "eraseWindowsVssSignature": boolean, "postKeyRevocationActionType": enum, "confidentialInstanceConfig": { "enableConfidentialCompute": boolean, "confidentialInstanceType": enum }, "fingerprint": string, "privateIpv6GoogleAccess": enum, "advancedMachineFeatures": { "enableNestedVirtualization": boolean, "threadsPerCore": integer, "visibleCoreCount": integer, "enableUefiNetworking": boolean, "performanceMonitoringUnit": enum, "turboMode": string }, "lastStartTimestamp": string, "lastStopTimestamp": string, "lastSuspendedTimestamp": string, "satisfiesPzs": boolean, "satisfiesPzi": boolean, "resourceStatus": { "scheduling": { "availabilityDomain": integer, "terminationTimestamp": string }, "upcomingMaintenance": { "type": enum, "canReschedule": boolean, "windowStartTime": string, "windowEndTime": string, "latestWindowStartTime": string, "maintenanceStatus": enum }, "physicalHost": string, "physicalHostTopology": { "cluster": string, "block": string, "subblock": string, "host": string }, "shutdownDetails": { "stopState": enum, "targetState": enum, "requestTimestamp": string, "maxDuration": { "seconds": string, "nanos": integer } } }, "networkPerformanceConfig": { "totalEgressBandwidthTier": enum }, "keyRevocationActionType": enum, "partnerMetadata": { string: { "entries": { string: value, ... } }, ... } } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }, ... }, "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ] } |
| Fields | |
|---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items |
An object that contains a list of instances scoped by zone. Key: [Output Only] Name of the scope containing this set of instances. |
items. |
[Output Only] A list of instances contained in this scope. |
items. |
[Output Only] Type of the resource. Always |
items. |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items. |
[Output Only] Creation timestamp in RFC3339 text format. |
items. |
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. |
An optional description of this resource. Provide this property when you create the resource. |
items. |
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. |
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
items. |
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. |
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. |
[Output Only] The status of the instance. One of the following values: |
items. |
[Output Only] An optional, human-readable explanation of the status. |
items. |
[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. |
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. |
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. |
[Output Only] Type of the resource. Always |
items. |
URL of the VPC 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. |
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. |
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. |
An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. |
items. |
The prefix length of the primary internal IPv6 range. |
items. |
[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the |
items. |
An array of configurations for this interface. Currently, only one access config, |
items. |
[Output Only] Type of the resource. Always |
items. |
The type of configuration. In |
items. |
The name of this access configuration. In |
items. |
Applies to |
items. |
Applies to |
items. |
Applies to |
items. |
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in |
items. |
The DNS domain name for the public PTR record. You can set this field only if the |
items. |
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. |
[Output Only] The resource URL for the security policy associated with this access config. |
items. |
An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, |
items. |
[Output Only] Type of the resource. Always |
items. |
The type of configuration. In |
items. |
The name of this access configuration. In |
items. |
Applies to |
items. |
Applies to |
items. |
Applies to |
items. |
Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in |
items. |
The DNS domain name for the public PTR record. You can set this field only if the |
items. |
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. |
[Output Only] The resource URL for the security policy associated with this access config. |
items. |
An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
items. |
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. |
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. |
Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an A base64-encoded string. |
items. |
The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use This field can be both set at instance creation and update network interface operations. |
items. |
[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if |
items. |
The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. |
items. |
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. |
items. |
The URL of the network attachment that this interface should connect to in the following format: projects/{projectNumber}/regions/{region_name}/networkAttachments/{network_attachment_name}. |
items. |
Array of disks associated with this instance. Persistent disks must be created before you can assign them. |
items. |
[Output Only] Type of the resource. Always |
items. |
Specifies the type of the disk, either |
items. |
The mode in which to attach this disk, either |
items. |
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to |
items. |
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, 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 for zonal disk, and the URL for regional disk. |
items. |
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. |
[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. |
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
items. |
[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. |
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. |
The source image to create this disk. When creating a new instance boot disk, 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. |
Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a |
items. |
Specifies the disk type to use to create the instance. If not specified, the default is
For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid:
pd-standard.
|
items. |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch 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. |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
items. |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items. |
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
items. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items. |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
items. |
Labels to apply to this disk. These can be later modified by the |
items. |
The source snapshot to create this disk. When creating a new instance boot disk, 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. |
The source instant-snapshot to create this disk. When creating a new instance boot disk, one of To create a disk with a snapshot that you created, specify the snapshot name in the following format:
If the source instant-snapshot is deleted later, this field will not be set. |
items. |
The customer-supplied encryption key of the source snapshot. |
items. |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
items. |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items. |
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
items. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items. |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
items. |
An optional description. Provide this property when creating the disk. |
items. |
Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone. |
items. |
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. |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
items. |
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. |
Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
items. |
Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. |
items. |
Indicates whether or not the disk can be read/write attached to more than one instance. |
items. |
A list of publicly visible licenses. Reserved for Google's use. |
items. |
The architecture of the attached disk. Valid values are arm64 or x86_64. |
items. |
Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format |
items. |
Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1. |
items. |
Whether this disk is using confidential compute mode. |
items. |
The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
|
items. |
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
items. |
[Output Only] Any valid publicly visible licenses. |
items. |
Specifies the disk interface to use for attaching this disk, which is either |
items. |
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. |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
items. |
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. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. |
items. |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
items. |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items. |
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
items. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items. |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
items. |
The size of the disk in GB. |
items. |
[Output Only] shielded vm initial state stored on disk |
items. |
The Platform Key (PK). |
items. |
The raw content in the secure keys file. A base64-encoded string. |
items. |
The file type of source file. |
items. |
The Key Exchange Key (KEK). |
items. |
The raw content in the secure keys file. A base64-encoded string. |
items. |
The file type of source file. |
items. |
The Key Database (db). |
items. |
The raw content in the secure keys file. A base64-encoded string. |
items. |
The file type of source file. |
items. |
The forbidden key database (dbx). |
items. |
The raw content in the secure keys file. A base64-encoded string. |
items. |
The file type of source file. |
items. |
[Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. |
items. |
[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. |
items. |
[Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. |
items. |
[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. |
items. |
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. |
items. |
[Output Only] Type of the resource. Always |
items. |
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. |
Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
items. |
Key for the metadata entry. Keys must conform to the following regexp: |
items. |
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. |
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. |
Email address of the service account. |
items. |
The list of scopes to be made available for this service account. |
items. |
[Output Only] Server-defined URL for this resource. |
items. |
Sets the scheduling options for this instance. |
items. |
Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration. |
items. |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items. |
Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. |
items. |
|
items. |
If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. |
items. |
Defines the maintenance behavior for this instance. For standard instances, the default behavior is |
items. |
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. |
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. |
A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
items. |
Corresponds to the label key of Node resource. |
items. |
Defines the operation of node selection. Valid operators are |
items. |
Corresponds to the label values of Node resource. |
items. |
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. |
items. |
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. |
Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. |
items. |
Specifies the frequency of planned maintenance events. The accepted values are: |
items. |
Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. |
items. |
Specifies the provisioning model of the instance. |
items. |
Specifies the termination action for the instance. |
items. |
Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. |
items. |
|
items. |
Opts-in for graceful shutdown. |
items. |
The time allotted for the instance to gracefully shut down. If the graceful shutdown isn't complete after this time, then the instance transitions to the STOPPING state. |
items. |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items. |
Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. |
items. |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items. |
[Output Only] The CPU platform used by this instance. |
items. |
Labels to apply to this instance. These can be later modified by the |
items. |
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. |
items. |
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format |
items. |
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. |
Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation. |
items. |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
items. |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items. |
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
items. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items. |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
items. |
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as |
items. |
A list of the type and count of accelerator cards attached to the instance. |
items. |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
items. |
The number of the guest accelerator cards exposed to this instance. |
items. |
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. |
items. |
Whether the resource should be protected against deletion. |
items. |
Resource policies applied to this instance. |
items. |
Source machine image |
items. |
Deprecating, please use shieldedInstanceConfig. |
items. |
Defines whether the instance has Secure Boot enabled. |
items. |
Defines whether the instance has the vTPM enabled. |
items. |
Defines whether the instance has integrity monitoring enabled. |
items. |
Deprecating, please use shieldedInstanceIntegrityPolicy. |
items. |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
items. |
Specifies the reservations that this instance can consume from. |
items. |
Specifies the type of reservation from which this instance can consume resources: |
items. |
Corresponds to the label key of a reservation resource. To target a |
items. |
Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. |
items. |
Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. |
items. |
Enables display device for the instance. |
items. |
Defines whether the instance has Display enabled. |
items. |
|
items. |
Defines whether the instance has Secure Boot enabled. Disabled by default. |
items. |
Defines whether the instance has the vTPM enabled. Enabled by default. |
items. |
Defines whether the instance has integrity monitoring enabled. Enabled by default. |
items. |
|
items. |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
items. |
Source machine image encryption key when creating an instance from a machine image. |
items. |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" |
items. |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
items. |
The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 |
items. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
items. |
The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ |
items. |
Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. |
items. |
PostKeyRevocationActionType of the instance. |
items. |
|
items. |
Defines whether the instance should have confidential compute enabled. |
items. |
Defines the type of technology used by the confidential instance. |
items. |
Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make A base64-encoded string. |
items. |
The private IPv6 google access type for the VM. If not specified, use |
items. |
Controls for advanced machine-related behavior features. |
items. |
Whether to enable nested virtualization or not (default is false). |
items. |
The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. |
items. |
The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. |
items. |
Whether to enable UEFI networking for instance creation. |
items. |
Type of Performance Monitoring Unit requested on instance. |
items. |
Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. |
items. |
[Output Only] Last start timestamp in RFC3339 text format. |
items. |
[Output Only] Last stop timestamp in RFC3339 text format. |
items. |
[Output Only] Last suspended timestamp in RFC3339 text format. |
items. |
[Output Only] Reserved for future use. |
items. |
[Output Only] Reserved for future use. |
items. |
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. |
items. |
|
items. |
Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. |
items. |
Time in future when the instance will be terminated in RFC3339 text format. |
items. |
|
items. |
Defines the type of maintenance. |
items. |
Indicates if the maintenance can be customer triggered. |
items. |
The current start time of the maintenance window. This timestamp value is in RFC3339 text format. |
items. |
The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. |
items. |
The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. |
items. |
|
items. |
[Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId/subBlockId/hostId. |
items. |
[Output Only] A series of fields containing the global name of the Compute Engine cluster, as well as the ID of the block, sub-block, and host on which the running instance is located. |
items. |
[Output Only] The global name of the Compute Engine cluster where the running instance is located. |
items. |
[Output Only] The ID of the block in which the running instance is located. Instances within the same block experience low network latency. |
items. |
[Output Only] The ID of the sub-block in which the running instance is located. Instances in the same sub-block experience lower network latency than instances in the same block. |
items. |
[Output Only] The ID of the host on which the running instance is located. Instances on the same host experience the lowest possible network latency. |
items. |
[Output Only] Details about the instance stopping state. |
items. |
|
items. |
|
items. |
|
items. |
|
items. |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items. |
|
items. |
|
items. |
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. |
items. |
Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map. |
items. |
Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct. |
items. |
[Output Only] Informational warning which replaces the list of instances when the list is empty. |
items. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items. |
[Output Only] A human-readable description of the warning code. |
items. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items. |
[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 |
items. |
[Output Only] A warning data value corresponding to the key. |
next |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
self |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning. |
[Output Only] A human-readable description of the warning code. |
warning. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning. |
[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 |
warning. |
[Output Only] A warning data value corresponding to the key. |
unreachables[] |
[Output Only] Unreachable resources. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonlyhttps://www.googleapis.com/auth/computehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.instances.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.