- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
HTTP request
PUT https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances/{instance}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
zone |
The name of the zone for this request. |
instance |
Name of the instance resource to update. |
Query parameters
| Parameters | |
|---|---|
request |
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( |
most |
Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. |
minimal |
Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "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": { "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, "maxRunDuration": { "seconds": string, "nanos": integer }, "terminationTime": string, "onInstanceStopAction": { "discardLocalSsd": boolean }, "hostErrorTimeoutSeconds": 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 }, "networkPerformanceConfig": { "totalEgressBandwidthTier": enum }, "keyRevocationActionType": enum, "partnerMetadata": { string: { "entries": { string: value, ... } }, ... } } |
| Fields | |
|---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creation |
[Output Only] Creation timestamp in RFC3339 text format. |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
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. Authorization requires the following IAM permission on the specified resource
|
tags. |
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
tags. |
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. |
machine |
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: |
status |
[Output Only] The status of the instance. One of the following values: |
status |
[Output Only] An optional, human-readable explanation of the status. |
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. |
can |
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. |
network |
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. |
network |
[Output Only] Type of the resource. Always |
network |
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:
Authorization requires one or more of the following IAM permissions on the specified resource
|
network |
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:
Authorization requires one or more of the following IAM permissions on the specified resource
|
network |
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. |
network |
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. |
network |
The prefix length of the primary internal IPv6 range. |
network |
[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the |
network |
An array of configurations for this interface. Currently, only one access config, |
network |
[Output Only] Type of the resource. Always |
network |
The type of configuration. In |
network |
The name of this access configuration. In |
network |
Applies to Authorization requires the following IAM permission on the specified resource
|
network |
Applies to |
network |
Applies to |
network |
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 |
network |
The DNS domain name for the public PTR record. You can set this field only if the |
network |
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. |
network |
[Output Only] The resource URL for the security policy associated with this access config. |
network |
An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, |
network |
[Output Only] Type of the resource. Always |
network |
The type of configuration. In |
network |
The name of this access configuration. In |
network |
Applies to Authorization requires the following IAM permission on the specified resource
|
network |
Applies to |
network |
Applies to |
network |
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 |
network |
The DNS domain name for the public PTR record. You can set this field only if the |
network |
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. |
network |
[Output Only] The resource URL for the security policy associated with this access config. |
network |
An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
network |
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 |
network |
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. |
network |
Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an A base64-encoded string. |
network |
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. |
network |
[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 |
network |
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. |
network |
The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. |
network |
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}. |
disks[] |
Array of disks associated with this instance. Persistent disks must be created before you can assign them. |
disks[]. |
[Output Only] Type of the resource. Always |
disks[]. |
Specifies the type of the disk, either |
disks[]. |
The mode in which to attach this disk, either |
disks[]. |
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to |
disks[]. |
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. Authorization requires one or more of the following IAM permissions on the specified resource
|
disks[]. |
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 |
disks[]. |
[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. |
disks[]. |
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
disks[]. |
[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 |
disks[]. |
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. |
disks[]. |
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. Authorization requires the following IAM permission on the specified resource
|
disks[]. |
Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a |
disks[]. |
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.
|
disks[]. |
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. |
disks[]. |
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=" |
disks[]. |
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 |
disks[]. |
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 |
disks[]. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
disks[]. |
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/ |
disks[]. |
Labels to apply to this disk. These can be later modified by the Authorization requires the following IAM permission on the specified resource
|
disks[]. |
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. Authorization requires the following IAM permission on the specified resource
|
disks[]. |
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. |
disks[]. |
The customer-supplied encryption key of the source snapshot. |
disks[]. |
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=" |
disks[]. |
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 |
disks[]. |
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 |
disks[]. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
disks[]. |
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/ |
disks[]. |
An optional description. Provide this property when creating the disk. |
disks[]. |
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. |
disks[]. |
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 |
disks[]. |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
disks[]. |
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. |
disks[]. |
Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
disks[]. |
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. |
disks[]. |
Indicates whether or not the disk can be read/write attached to more than one instance. |
disks[]. |
A list of publicly visible licenses. Reserved for Google's use. |
disks[]. |
The architecture of the attached disk. Valid values are arm64 or x86_64. |
disks[]. |
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 |
disks[]. |
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. |
disks[]. |
Whether this disk is using confidential compute mode. |
disks[]. |
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:
Authorization requires the following IAM permission on the specified resource
|
disks[]. |
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
disks[]. |
[Output Only] Any valid publicly visible licenses. |
disks[]. |
Specifies the disk interface to use for attaching this disk, which is either |
disks[]. |
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
disks[]. |
The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:
|
disks[]. |
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. |
disks[]. |
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=" |
disks[]. |
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 |
disks[]. |
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 |
disks[]. |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
disks[]. |
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/ |
disks[]. |
The size of the disk in GB. |
disks[]. |
[Output Only] shielded vm initial state stored on disk |
disks[]. |
The Platform Key (PK). |
disks[]. |
The raw content in the secure keys file. A base64-encoded string. |
disks[]. |
The file type of source file. |
disks[]. |
The Key Exchange Key (KEK). |
disks[]. |
The raw content in the secure keys file. A base64-encoded string. |
disks[]. |
The file type of source file. |
disks[]. |
The Key Database (db). |
disks[]. |
The raw content in the secure keys file. A base64-encoded string. |
disks[]. |
The file type of source file. |
disks[]. |
The forbidden key database (dbx). |
disks[]. |
The raw content in the secure keys file. A base64-encoded string. |
disks[]. |
The file type of source file. |
disks[]. |
[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. |
disks[]. |
[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. |
disks[]. |
[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. |
disks[]. |
[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. |
metadata |
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. Authorization requires the following IAM permission on the specified resource
|
metadata. |
[Output Only] Type of the resource. Always |
metadata. |
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. |
metadata. |
Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
metadata. |
Key for the metadata entry. Keys must conform to the following regexp: |
metadata. |
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). |
service |
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. Authorization requires the following IAM permission on the specified resource
|
service |
Email address of the service account. Authorization requires the following IAM permission on the specified resource
|
service |
The list of scopes to be made available for this service account. |
self |
[Output Only] Server-defined URL for this resource. |
scheduling |
Sets the scheduling options for this instance. |
scheduling. |
Defines the maintenance behavior for this instance. For standard instances, the default behavior is |
scheduling. |
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 |
scheduling. |
Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a |
scheduling. |
A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
scheduling. |
Corresponds to the label key of Node resource. |
scheduling. |
Defines the operation of node selection. Valid operators are |
scheduling. |
Corresponds to the label values of Node resource. |
scheduling. |
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. |
scheduling. |
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. |
scheduling. |
Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. |
scheduling. |
Specifies the frequency of planned maintenance events. The accepted values are: |
scheduling. |
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. |
scheduling. |
Specifies the provisioning model of the instance. |
scheduling. |
Specifies the termination action for the instance. |
scheduling. |
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. |
scheduling. |
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 |
scheduling. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
scheduling. |
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. |
scheduling. |
|
scheduling. |
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. |
scheduling. |
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. |
scheduling. |
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. |
scheduling. |
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 |
scheduling. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
cpu |
[Output Only] The CPU platform used by this instance. |
labels |
Labels to apply to this instance. These can be later modified by the Authorization requires the following IAM permission on the specified resource
|
params |
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. |
params. |
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 |
label |
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. |
instance |
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. |
instance |
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=" |
instance |
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 |
instance |
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 |
instance |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
instance |
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/ |
min |
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as |
guest |
A list of the type and count of accelerator cards attached to the instance. |
guest |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
guest |
The number of the guest accelerator cards exposed to this instance. |
start |
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. |
deletion |
Whether the resource should be protected against deletion. Authorization requires the following IAM permission on the specified resource
|
resource |
Resource policies applied to this instance. Authorization requires the following IAM permission on the specified resource
|
source |
Source machine image Authorization requires one or more of the following IAM permissions on the specified resource
|
shielded |
Deprecating, please use shieldedInstanceConfig. |
shielded |
Defines whether the instance has Secure Boot enabled. |
shielded |
Defines whether the instance has the vTPM enabled. |
shielded |
Defines whether the instance has integrity monitoring enabled. |
shielded |
Deprecating, please use shieldedInstanceIntegrityPolicy. |
shielded |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
reservation |
Specifies the reservations that this instance can consume from. |
reservation |
Specifies the type of reservation from which this instance can consume resources: |
reservation |
Corresponds to the label key of a reservation resource. To target a |
reservation |
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. |
hostname |
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. |
display |
Enables display device for the instance. |
display |
Defines whether the instance has Display enabled. |
shielded |
|
shielded |
Defines whether the instance has Secure Boot enabled. Disabled by default. |
shielded |
Defines whether the instance has the vTPM enabled. Enabled by default. |
shielded |
Defines whether the instance has integrity monitoring enabled. Enabled by default. |
shielded |
|
shielded |
Updates the integrity policy baseline using the measurements from the VM instance's most recent boot. |
source |
Source machine image encryption key when creating an instance from a machine image. |
source |
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=" |
source |
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 |
source |
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 |
source |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
source |
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/ |
erase |
Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. |
post |
PostKeyRevocationActionType of the instance. |
confidential |
|
confidential |
Defines whether the instance should have confidential compute enabled. |
confidential |
Defines the type of technology used by the confidential instance. |
fingerprint |
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. |
private |
The private IPv6 google access type for the VM. If not specified, use |
advanced |
Controls for advanced machine-related behavior features. |
advanced |
Whether to enable nested virtualization or not (default is false). |
advanced |
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. |
advanced |
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. |
advanced |
Whether to enable UEFI networking for instance creation. |
advanced |
Type of Performance Monitoring Unit requested on instance. |
advanced |
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. |
last |
[Output Only] Last start timestamp in RFC3339 text format. |
last |
[Output Only] Last stop timestamp in RFC3339 text format. |
last |
[Output Only] Last suspended timestamp in RFC3339 text format. |
satisfies |
[Output Only] Reserved for future use. |
satisfies |
[Output Only] Reserved for future use. |
resource |
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. |
resource |
|
resource |
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. |
resource |
Time in future when the instance will be terminated in RFC3339 text format. |
resource |
|
resource |
Defines the type of maintenance. |
resource |
Indicates if the maintenance can be customer triggered. |
resource |
The current start time of the maintenance window. This timestamp value is in RFC3339 text format. |
resource |
The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. |
resource |
The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. |
resource |
|
resource |
[Output Only] An opaque ID of the host on which the VM is running. |
network |
|
network |
|
key |
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. |
partner |
Partner Metadata assigned to the instance. A map from a subdomain (namespace) to entries map. |
partner |
Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct. |
Response body
Represents an Operation resource.
Google Compute Engine has three Operation resources:
You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
Operations can be global, regional or zonal.
- For global operations, use the
globalOperationsresource. - For regional operations, use the
regionOperationsresource. - For zonal operations, use the
zoneOperationsresource.
For more information, read Global, Regional, and Zonal Resources.
Note that completed Operation resources have a limited retention period.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field |
| Fields | |
|---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creation |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
client |
[Output Only] The value of |
operation |
[Output Only] The type of operation, such as |
target |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. |
target |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
status |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
insert |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
start |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
end |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error. |
[Output Only] The array of errors encountered while processing this operation. |
error. |
[Output Only] The error type identifier for this error. |
error. |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error. |
[Output Only] An optional, human-readable error message. |
error. |
[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
error. |
|
error. |
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of |
error. |
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
error. |
Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. |
error. |
|
error. |
The Compute Engine quota metric name. |
error. |
The name of the quota limit. |
error. |
The map holding related quota dimensions. |
error. |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error. |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error. |
Rollout status of the future quota limit. |
error. |
|
error. |
URL(s) pointing to additional information on handling the current error. |
error. |
Describes what the link offers. |
error. |
The URL of the link. |
error. |
|
error. |
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" |
error. |
The localized error message in the above locale. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[]. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[]. |
[Output Only] A human-readable description of the warning code. |
warnings[]. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[]. |
[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 |
warnings[]. |
[Output Only] A warning data value corresponding to the key. |
http |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
http |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
self |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
operation |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata. [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
set |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
set |
[Output Only] The client operation id. |
set |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
set |
[Output Only] Status of the action, which can be one of the following: |
set |
[Output Only] If state is |
set |
The status code, which should be an enum value of |
set |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
set |
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
instances |
|
instances |
Status information per location (location name is key). Example key: zones/us-central1-a |
instances |
[Output Only] Creation status of instances.bulkInsert operation - information if the flow is rolling forward or rolling back. |
instances |
[Output Only] Count of VMs originally planned to be created. |
instances |
[Output Only] Count of VMs successfully created so far. |
instances |
[Output Only] Count of VMs that started creating but encountered an error. |
instances |
[Output Only] Count of VMs that got deleted during rollback. |
Authorization scopes
Requires one of the following OAuth scopes:
https://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.disks.createcompute.instances.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.