Restore from a snapshot Stay organized with collections Save and categorize content based on your preferences.
A disk is either a boot disk that is used to start and run the operating systemon a compute instance or a non-boot disk that an instance uses only fordata storage.
You can use snapshots to backup and restore disk data in the following ways:
After you take a snapshot of a boot or non-boot disk,create a new disk based on the snapshot.
After you take a snapshot of a boot disk,create a new instance based on the boot disk snapshot.
After you take a snapshot of a non-boot disk,create a new instance with a new non-boot disk based on the snapshot.
Before you begin
- If you haven't already, set upauthentication. Authentication verifies your identity for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:
Select the tab for how you plan to use the samples on this page:
Console
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
Install the Google Cloud CLI. After installation,initialize the Google Cloud CLI by running the following command:
gcloudinit
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.- Set a default region and zone.
Go
To use the Go samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
Java
To use the Java samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
Node.js
To use the Node.js samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
Python
To use the Python samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
REST
To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Note: If you installed the gcloud CLI previously, make sure you have the latest version by runninggcloud components update.For more information, seeAuthenticate for using REST in the Google Cloud authentication documentation.
Required roles
To get the permissions that you need to restore from a snapshot, ask your administrator to grant you theCompute Instance Admin (v1) (roles/compute.instanceAdmin.v1) IAM role on the project. For more information about granting roles, seeManage access to projects, folders, and organizations.
This predefined role contains the permissions required to restore from a snapshot. To see the exact permissions that are required, expand theRequired permissions section:
Required permissions
The following permissions are required to restore from a snapshot:
- To create a disk from a globally scoped snapshot (default):
compute.disks.createon the projectcompute.instances.attachDiskon the instancecompute.disks.useon the disk to attachcompute.snapshots.useReadOnly,compute.snapshots.create, orcompute.disks.createSnapshoton the project
- To create a disk from a regionally scoped snapshot:
compute.disks.createon the projectcompute.instances.attachDiskon the instancecompute.disks.useon the disk to attachcompute.snapshots.useReadOnlyon the project
- To create an instance from a boot disk and non-boot disk snapshot, at a minimum, you need the following permissions:
compute.instances.createon the projectcompute.snapshots.useReadOnlyon the snapshotcompute.disks.createon the projectcompute.disks.useon the diskcompute.instances.attachDiskon the instance
You might also be able to get these permissions withcustom roles or otherpredefined roles.
Limitations
The new disk must be at least the same size as the original sourcedisk for the snapshot. If you create a disk that is largerthan the original source disk for the snapshot, you mustresize the file system on that diskto include the additional disk space. Depending on your operating system andfile system type, you might need to use a different file system resizing tool.For more information, see your operating system documentation.
You can create a new zonal or regional disks from a givensnapshot at most once every ten minutes. If you want to issue a burst ofrequests to snapshot your disks, you can issue at most 6 requests in 60minutes. This limit does not apply when creating regional disks from asnapshot. For more information, seeSnapshot frequency limits.
Create a disk from a snapshot and optionally attach it to an instance
If you backed up a boot or non-boot disk with a snapshot, you can create a newdisk based on the snapshot.
Console
In the Google Cloud console, go to theSnapshots page.
Find the name of the snapshot that you want to restore.
Go to theDisks page.
ClickCreate new disk.
Specify the following configuration parameters:
- A name for the disk.
- A type for the disk.
- Optionally, you can override the default region and zone selection.You can select any region and zone, regardless of the storagelocation of the source snapshot.
UnderSource type, clickSnapshot.
Select the name of the snapshot to restore.
Select the size of the new disk, in gigabytes. This number must be equalto or larger than the original source disk for the snapshot.
ClickCreate to create the disk.
Optionally, you can thenattach a non-boot disk to a instance.
gcloud
Use the
gcloud compute snapshots listcommandto find the name of the snapshot you want to restore:gcloud compute snapshots list
Use the
gcloud compute snapshots describecommandto find the size of the snapshot you want to restore:gcloud compute snapshots describeSNAPSHOT_NAME
ReplaceSNAPSHOT_NAME with the name of the snapshot beingrestored.
Use the
gcloud compute disks createcommandto create a new regional or zonal disk from yoursnapshot. You can include the--typeflag to specify the type ofdisk to create.- To create a zonal disk from a globally scoped snapshot:
gcloud compute disks createDISK_NAME \ --zone=ZONE \ --size=DISK_SIZE \ --source-snapshot=SNAPSHOT_NAME \ --type=DISK_TYPE
- (Preview) To create a zonal diskfrom a regionally scoped snapshot:
gcloud beta compute disks createDISK_NAME \ --zone=ZONE \ --source-snapshot=SNAPSHOT_NAME \ --source-snapshot-region=SOURCE_REGION \ --type=DISK_TYPE
- To create a regional disk from a globally scoped snapshot:
gcloud beta compute disks createDISK_NAME \ --size=DISK_SIZE \ --source-snapshot=SNAPSHOT_NAME \ --type=DISK_TYPE \ --region=REGION \ --replica-zones=ZONE1,ZONE2
- (Preview) To create a regionaldisk from a regionally scoped snapshot:
gcloud beta compute disks createDISK_NAME \ --size=DISK_SIZE \ --source-snapshot=SNAPSHOT_NAME \ --source-snapshot-region=SOURCE_REGION \ --type=DISK_TYPE \ --region=REGION \ --replica-zones=ZONE1,ZONE2
Replace the following:
- DISK_NAME: the name of the new disk
- DISK_SIZE: the size of the new disk, in gibibytes (GiB).This number must be equal to or larger than the original source diskfor the snapshot.
- SNAPSHOT_NAME: the name of the snapshot being restored
- DISK_TYPE: thetype of the disk, for example,
pd-ssd,hyperdisk-throughputorhyperdisk-balanced-high-availability - REGION: the region for the regional disk to reside in,for example:
europe-west1 - SOURCE_REGION: the region that the source snapshot is scoped to
- ZONE: the zone where the new disk will reside
- ZONE1,ZONE2: the zones within the region where the twodisk replicas are located, for example:
europe-west1-bandeurope-west1-c
Optional: Attach the new disk to an existing instance by using the
gcloud compute instances attach-diskcommand:gcloud compute instances attach-diskINSTANCE_NAME \ --diskDISK_NAME
Replace the following:
- INSTANCE_NAME: the name of the instance
- DISK_NAME: the name of the disk made from your snapshot
Go
Go
Before trying this sample, follow theGo setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineGo API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
import("context""fmt""io"compute"cloud.google.com/go/compute/apiv1"computepb"cloud.google.com/go/compute/apiv1/computepb""google.golang.org/protobuf/proto")// createDiskFromSnapshot creates a new disk in a project in given zone.funccreateDiskFromSnapshot(wio.Writer,projectID,zone,diskName,diskType,snapshotLinkstring,diskSizeGbint64,)error{// projectID := "your_project_id"// zone := "us-west3-b" // should match diskType below// diskName := "your_disk_name"// diskType := "zones/us-west3-b/diskTypes/pd-ssd"// snapshotLink := "projects/your_project_id/global/snapshots/snapshot_name"// diskSizeGb := 120ctx:=context.Background()disksClient,err:=compute.NewDisksRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewDisksRESTClient: %w",err)}deferdisksClient.Close()req:=&computepb.InsertDiskRequest{Project:projectID,Zone:zone,DiskResource:&computepb.Disk{Name:proto.String(diskName),Zone:proto.String(zone),Type:proto.String(diskType),SourceSnapshot:proto.String(snapshotLink),SizeGb:proto.Int64(diskSizeGb),},}op,err:=disksClient.Insert(ctx,req)iferr!=nil{returnfmt.Errorf("unable to create disk: %w",err)}iferr=op.Wait(ctx);err!=nil{returnfmt.Errorf("unable to wait for the operation: %w",err)}fmt.Fprintf(w,"Disk created\n")returnnil}Java
Java
Before trying this sample, follow theJava setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineJava API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
importcom.google.cloud.compute.v1.Disk;importcom.google.cloud.compute.v1.DisksClient;importcom.google.cloud.compute.v1.InsertDiskRequest;importcom.google.cloud.compute.v1.Operation;importjava.io.IOException;importjava.util.concurrent.ExecutionException;importjava.util.concurrent.TimeUnit;importjava.util.concurrent.TimeoutException;publicclassCreateDiskFromSnapshot{publicstaticvoidmain(String[]args)throwsIOException,ExecutionException,InterruptedException,TimeoutException{// TODO(developer): Replace these variables before running the sample.// Project ID or project number of the Cloud project you want to use.StringprojectId="YOUR_PROJECT_ID";// Name of the zone in which you want to create the disk.Stringzone="europe-central2-b";// Name of the disk you want to create.StringdiskName="YOUR_DISK_NAME";// The type of disk you want to create. This value uses the following format:// "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".// For example: "zones/us-west3-b/diskTypes/pd-ssd"StringdiskType=String.format("zones/%s/diskTypes/pd-ssd",zone);// Size of the new disk in gigabytes.longdiskSizeGb=10;// The full path and name of the snapshot that you want to use as the source for the new disk.// This value uses the following format:// "projects/{projectName}/global/snapshots/{snapshotName}"StringsnapshotLink=String.format("projects/%s/global/snapshots/%s",projectId,"SNAPSHOT_NAME");createDiskFromSnapshot(projectId,zone,diskName,diskType,diskSizeGb,snapshotLink);}// Creates a new disk in a project in given zone, using a snapshot.publicstaticvoidcreateDiskFromSnapshot(StringprojectId,Stringzone,StringdiskName,StringdiskType,longdiskSizeGb,StringsnapshotLink)throwsIOException,ExecutionException,InterruptedException,TimeoutException{// Initialize client that will be used to send requests. This client only needs to be created// once, and can be reused for multiple requests. After completing all of your requests, call// the `disksClient.close()` method on the client to safely// clean up any remaining background resources.try(DisksClientdisksClient=DisksClient.create()){// Set the disk properties and the source snapshot.Diskdisk=Disk.newBuilder().setName(diskName).setZone(zone).setSizeGb(diskSizeGb).setType(diskType).setSourceSnapshot(snapshotLink).build();// Create the insert disk request.InsertDiskRequestinsertDiskRequest=InsertDiskRequest.newBuilder().setProject(projectId).setZone(zone).setDiskResource(disk).build();// Wait for the create disk operation to complete.Operationresponse=disksClient.insertAsync(insertDiskRequest).get(3,TimeUnit.MINUTES);if(response.hasError()){System.out.println("Disk creation failed!"+response);return;}System.out.println("Disk created. Operation Status: "+response.getStatus());}}}Node.js
Node.js
Before trying this sample, follow theNode.js setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineNode.js API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
/** * TODO(developer): Uncomment and replace these variables before running the sample. */// const projectId = 'YOUR_PROJECT_ID';// const zone = 'europe-central2-b';// const diskName = 'YOUR_DISK_NAME';// const diskType = 'zones/us-west3-b/diskTypes/pd-ssd';// const diskSizeGb = 10;// const snapshotLink = 'projects/project_name/global/snapshots/snapshot_name';constcompute=require('@google-cloud/compute');asyncfunctioncreateDiskFromSnapshot(){constdisksClient=newcompute.DisksClient();const[response]=awaitdisksClient.insert({project:projectId,zone,diskResource:{sizeGb:diskSizeGb,name:diskName,zone,type:diskType,sourceSnapshot:snapshotLink,},});letoperation=response.latestResponse;constoperationsClient=newcompute.ZoneOperationsClient();// Wait for the create disk operation to complete.while(operation.status!=='DONE'){[operation]=awaitoperationsClient.wait({operation:operation.name,project:projectId,zone:operation.zone.split('/').pop(),});}console.log('Disk created.');}createDiskFromSnapshot();Python
Python
Before trying this sample, follow thePython setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EnginePython API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
from__future__importannotationsimportsysfromtypingimportAnyfromgoogle.api_core.extended_operationimportExtendedOperationfromgoogle.cloudimportcompute_v1defwait_for_extended_operation(operation:ExtendedOperation,verbose_name:str="operation",timeout:int=300)->Any:""" Waits for the extended (long-running) operation to complete. If the operation is successful, it will return its result. If the operation ends with an error, an exception will be raised. If there were any warnings during the execution of the operation they will be printed to sys.stderr. Args: operation: a long-running operation you want to wait on. verbose_name: (optional) a more verbose name of the operation, used only during error and warning reporting. timeout: how long (in seconds) to wait for operation to finish. If None, wait indefinitely. Returns: Whatever the operation.result() returns. Raises: This method will raise the exception received from `operation.exception()` or RuntimeError if there is no exception set, but there is an `error_code` set for the `operation`. In case of an operation taking longer than `timeout` seconds to complete, a `concurrent.futures.TimeoutError` will be raised. """result=operation.result(timeout=timeout)ifoperation.error_code:print(f"Error during{verbose_name}: [Code:{operation.error_code}]:{operation.error_message}",file=sys.stderr,flush=True,)print(f"Operation ID:{operation.name}",file=sys.stderr,flush=True)raiseoperation.exception()orRuntimeError(operation.error_message)ifoperation.warnings:print(f"Warnings during{verbose_name}:\n",file=sys.stderr,flush=True)forwarninginoperation.warnings:print(f" -{warning.code}:{warning.message}",file=sys.stderr,flush=True)returnresultdefcreate_disk_from_snapshot(project_id:str,zone:str,disk_name:str,disk_type:str,disk_size_gb:int,snapshot_link:str,)->compute_v1.Disk:""" Creates a new disk in a project in given zone. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone in which you want to create the disk. disk_name: name of the disk you want to create. disk_type: the type of disk you want to create. This value uses the following format: "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example: "zones/us-west3-b/diskTypes/pd-ssd" disk_size_gb: size of the new disk in gigabytes snapshot_link: a link to the snapshot you want to use as a source for the new disk. This value uses the following format: "projects/{project_name}/global/snapshots/{snapshot_name}" Returns: An unattached Disk instance. """disk_client=compute_v1.DisksClient()disk=compute_v1.Disk()disk.zone=zonedisk.size_gb=disk_size_gbdisk.source_snapshot=snapshot_linkdisk.type_=disk_typedisk.name=disk_nameoperation=disk_client.insert(project=project_id,zone=zone,disk_resource=disk)wait_for_extended_operation(operation,"disk creation")returndisk_client.get(project=project_id,zone=zone,disk=disk_name)REST
Construct a
GETrequest tosnapshots.listto display the list of snapshots in your project.GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/snapshots
ReplacePROJECT_ID with your project ID.
Construct a
POSTrequest to create a zonal disk or aregional disk using therespectivedisks.insertmethod:- For zonal disks:
disks.insert - For regional disks:
regionDisks.insert
Include the
name,sizeGb, andtypeproperties. To restore a diskusing a snapshot, you must include thesourceSnapshotproperty.- To create a zonal disk from a globally scoped snapshot:
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/disks{ "name": "DISK_NAME", "sourceSnapshot": "SNAPSHOT_NAME", "sizeGb": "DISK_SIZE", "type": "zones/ZONE/diskTypes/DISK_TYPE"}- (Preview) To create a zonaldisk from a regionally scoped snapshot:
POST https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/zones/ZONE/disks{ "name": "DISK_NAME", "sourceSnapshot": "projects/PROJECT_ID/regions/SOURCE_REGION/snapshots/SNAPSHOT_NAME", "sizeGb": "DISK_SIZE", "type": "projects/PROJECT_ID/zones/ZONE/diskTypes/DISK_TYPE", "zone": "projects/PROJECT_ID/zones/ZONE"}- To create a regional disk from a globally scoped snapshot:
POST https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/regions/REGION/disks{ "name": "DISK_NAME", "sourceSnapshot": "SNAPSHOT_NAME", "region": "projects/PROJECT_ID/regions/REGION", "replicaZones": [ "projects/PROJECT_ID/zones/ZONE1", "projects/PROJECT_ID/zones/ZONE2" ], "sizeGb": "DISK_SIZE", "type": "zones/ZONE/diskTypes/DISK_TYPE"}- (Preview) To create a regionaldisk from a regionally scoped snapshot:
POST https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/regions/REGION/disks{ "name": "DISK_NAME", "sourceSnapshot": "projects/PROJECT_ID/regions/SOURCE_REGION/snapshots/SNAPSHOT_NAME", "replicaZones": [ "projects/PROJECT_ID/zones/ZONE1", "projects/PROJECT_ID/zones/ZONE2" ], "sizeGb": "DISK_SIZE", "type": "projects/PROJECT_ID/regions/REGION/diskTypes/DISK_TYPE"}Replace the following:
- PROJECT_ID: your project ID
- ZONE: the zone where your instance and newdisk are located
- DISK_NAME: the name of the new disk
- SNAPSHOT_NAME: the source snapshot for the disk thatyou are restoring
- REGION: the region for the regional disk to reside in,for example:
europe-west1 - SOURCE_REGION: the region that the source snapshot is scoped to
- ZONE1,ZONE2: the zones where replicas of thenew disk should be located
- DISK_SIZE: the size of the new disk, in gibibytes (GiB).This number must be equal to or larger than the original sourcedisk for the snapshot.
- DISK_TYPE: full or partial URL for thetypeof the disk, for example,
PROJECT_ID/zones/ZONE/diskTypes/pd-ssd,PROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balancedorPROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balanced-high-availability
- For zonal disks:
Optional. Attach the new disk to an existing instance.
Construct a
POSTrequest to theinstances.attachDiskmethod,and include the URL to the disk that you just created from yoursnapshot.For zonal disks:
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/INSTANCE_NAME/attachDisk{ "source": "/compute/v1/projects/PROJECT_ID/zones/ZONE/disks/DISK_NAME"}For regional disks:
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/INSTANCE_NAME/attachDisk{ "source": "/compute/v1/projects/PROJECT_ID/regions/REGION/disks/DISK_NAME"}Replace the following:
- PROJECT_ID: your project ID
- ZONE: the zone where your instance and new disk are located
- REGION: the region where the regional disk is located.This must be the same region that the compute instance is located in.
- INSTANCE_NAME: the name of the instance where you areadding the new disk
- DISK_NAME: the name of the new disk
After you create and attach a new disk to an instance, you mustmount the diskso that the operating system can use the available storage space.
Create an instance from existing disks
You can create boot disks and data disks from snapshots and then attach thesedisks to a new compute instance.
Go
Go
Before trying this sample, follow theGo setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineGo API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
import("context""fmt""io"compute"cloud.google.com/go/compute/apiv1"computepb"cloud.google.com/go/compute/apiv1/computepb""google.golang.org/protobuf/proto")// createWithExistingDisks create a new VM instance using selected disks.// The first disk in diskNames will be used as boot disk.funccreateWithExistingDisks(wio.Writer,projectID,zone,instanceNamestring,diskNames[]string,)error{// projectID := "your_project_id"// zone := "europe-central2-b"// instanceName := "your_instance_name"// diskNames := []string{"boot_disk", "disk1", "disk2"}ctx:=context.Background()instancesClient,err:=compute.NewInstancesRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewInstancesRESTClient: %w",err)}deferinstancesClient.Close()disksClient,err:=compute.NewDisksRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewDisksRESTClient: %w",err)}deferdisksClient.Close()disks:=[](*computepb.Disk){}for_,diskName:=rangediskNames{reqDisk:=&computepb.GetDiskRequest{Project:projectID,Zone:zone,Disk:diskName,}disk,err:=disksClient.Get(ctx,reqDisk)iferr!=nil{returnfmt.Errorf("unable to get disk: %w",err)}disks=append(disks,disk)}attachedDisks:=[](*computepb.AttachedDisk){}for_,disk:=rangedisks{attachedDisk:=&computepb.AttachedDisk{Source:proto.String(disk.GetSelfLink()),}attachedDisks=append(attachedDisks,attachedDisk)}attachedDisks[0].Boot=proto.Bool(true)instanceResource:=&computepb.Instance{Name:proto.String(instanceName),Disks:attachedDisks,MachineType:proto.String(fmt.Sprintf("zones/%s/machineTypes/n1-standard-1",zone)),NetworkInterfaces:[]*computepb.NetworkInterface{{Name:proto.String("global/networks/default"),},},}req:=&computepb.InsertInstanceRequest{Project:projectID,Zone:zone,InstanceResource:instanceResource,}op,err:=instancesClient.Insert(ctx,req)iferr!=nil{returnfmt.Errorf("unable to create instance: %w",err)}iferr=op.Wait(ctx);err!=nil{returnfmt.Errorf("unable to wait for the operation: %w",err)}fmt.Fprintf(w,"Instance created\n")returnnil}Java
Java
Before trying this sample, follow theJava setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineJava API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
importcom.google.cloud.compute.v1.AttachedDisk;importcom.google.cloud.compute.v1.Disk;importcom.google.cloud.compute.v1.DisksClient;importcom.google.cloud.compute.v1.InsertInstanceRequest;importcom.google.cloud.compute.v1.Instance;importcom.google.cloud.compute.v1.InstancesClient;importcom.google.cloud.compute.v1.NetworkInterface;importcom.google.cloud.compute.v1.Operation;importjava.io.IOException;importjava.util.ArrayList;importjava.util.List;importjava.util.concurrent.ExecutionException;importjava.util.concurrent.TimeUnit;importjava.util.concurrent.TimeoutException;publicclassCreateInstanceWithExistingDisks{publicstaticvoidmain(String[]args)throwsIOException,ExecutionException,InterruptedException,TimeoutException{// TODO(developer): Replace these variables before running the sample.// Project ID or project number of the Cloud project you want to use.StringprojectId="YOUR_PROJECT_ID";// Name of the zone to create the instance in. For example: "us-west3-b"Stringzone="europe-central2-b";// Name of the new virtual machine (VM) instance.StringinstanceName="YOUR_INSTANCE_NAME";// Array of disk names to be attached to the new virtual machine.// First disk in this list will be used as the boot disk.List<String>diskNames=List.of("your-boot-disk","another-disk1","another-disk2");createInstanceWithExistingDisks(projectId,zone,instanceName,diskNames);}// Create a new VM instance using the selected disks.// The first disk in diskNames will be used as the boot disk.publicstaticvoidcreateInstanceWithExistingDisks(StringprojectId,Stringzone,StringinstanceName,List<String>diskNames)throwsIOException,ExecutionException,InterruptedException,TimeoutException{// Initialize client that will be used to send requests. This client only needs to be created// once, and can be reused for multiple requests. After completing all of your requests, call// the `instancesClient.close()` method on the client to safely// clean up any remaining background resources.try(InstancesClientinstancesClient=InstancesClient.create();DisksClientdisksClient=DisksClient.create()){if(diskNames.size()==0){thrownewError("At least one disk should be provided");}// Create the list of attached disks to be used in instance creation.List<AttachedDisk>attachedDisks=newArrayList<>();for(inti=0;i <diskNames.size();i++){StringdiskName=diskNames.get(i);Diskdisk=disksClient.get(projectId,zone,diskName);AttachedDiskattDisk=null;if(i==0){// Make the first disk in the list as the boot disk.attDisk=AttachedDisk.newBuilder().setSource(disk.getSelfLink()).setBoot(true).build();}else{attDisk=AttachedDisk.newBuilder().setSource(disk.getSelfLink()).build();}attachedDisks.add(attDisk);}// Create the instance.Instanceinstance=Instance.newBuilder().setName(instanceName)// Add the attached disks to the instance..addAllDisks(attachedDisks).setMachineType(String.format("zones/%s/machineTypes/n1-standard-1",zone)).addNetworkInterfaces(NetworkInterface.newBuilder().setName("global/networks/default").build()).build();// Create the insert instance request.InsertInstanceRequestinsertInstanceRequest=InsertInstanceRequest.newBuilder().setProject(projectId).setZone(zone).setInstanceResource(instance).build();// Wait for the create operation to complete.Operationresponse=instancesClient.insertAsync(insertInstanceRequest).get(3,TimeUnit.MINUTES);if(response.hasError()){System.out.println("Instance creation failed!"+response);return;}System.out.println("Operation Status: "+response.getStatus());}}}Node.js
Node.js
Before trying this sample, follow theNode.js setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineNode.js API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
/** * TODO(developer): Uncomment and replace these variables before running the sample. */// const projectId = 'YOUR_PROJECT_ID';// const zone = 'europe-central2-b';// const instanceName = 'YOUR_INSTANCE_NAME';// const diskNames = ['boot_disk', 'disk1', 'disk2'];constcompute=require('@google-cloud/compute');asyncfunctioncreateWithExistingDisks(){constinstancesClient=newcompute.InstancesClient();constdisksClient=newcompute.DisksClient();if(diskNames.length <1){thrownewError('At least one disk should be provided');}constdisks=[];for(constdiskNameofdiskNames){const[disk]=awaitdisksClient.get({project:projectId,zone,disk:diskName,});disks.push(disk);}constattachedDisks=[];for(constdiskofdisks){attachedDisks.push({source:disk.selfLink,});}attachedDisks[0].boot=true;const[response]=awaitinstancesClient.insert({project:projectId,zone,instanceResource:{name:instanceName,disks:attachedDisks,machineType:`zones/${zone}/machineTypes/n1-standard-1`,networkInterfaces:[{name:'global/networks/default',},],},});letoperation=response.latestResponse;constoperationsClient=newcompute.ZoneOperationsClient();// Wait for the create operation to complete.while(operation.status!=='DONE'){[operation]=awaitoperationsClient.wait({operation:operation.name,project:projectId,zone:operation.zone.split('/').pop(),});}console.log('Instance created.');}createWithExistingDisks();Python
Python
Before trying this sample, follow thePython setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EnginePython API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
from__future__importannotationsimportreimportsysfromtypingimportAnyimportwarningsfromgoogle.api_core.extended_operationimportExtendedOperationfromgoogle.cloudimportcompute_v1defget_disk(project_id:str,zone:str,disk_name:str)->compute_v1.Disk:""" Gets a disk from a project. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone where the disk exists. disk_name: name of the disk you want to retrieve. """disk_client=compute_v1.DisksClient()returndisk_client.get(project=project_id,zone=zone,disk=disk_name)defwait_for_extended_operation(operation:ExtendedOperation,verbose_name:str="operation",timeout:int=300)->Any:""" Waits for the extended (long-running) operation to complete. If the operation is successful, it will return its result. If the operation ends with an error, an exception will be raised. If there were any warnings during the execution of the operation they will be printed to sys.stderr. Args: operation: a long-running operation you want to wait on. verbose_name: (optional) a more verbose name of the operation, used only during error and warning reporting. timeout: how long (in seconds) to wait for operation to finish. If None, wait indefinitely. Returns: Whatever the operation.result() returns. Raises: This method will raise the exception received from `operation.exception()` or RuntimeError if there is no exception set, but there is an `error_code` set for the `operation`. In case of an operation taking longer than `timeout` seconds to complete, a `concurrent.futures.TimeoutError` will be raised. """result=operation.result(timeout=timeout)ifoperation.error_code:print(f"Error during{verbose_name}: [Code:{operation.error_code}]:{operation.error_message}",file=sys.stderr,flush=True,)print(f"Operation ID:{operation.name}",file=sys.stderr,flush=True)raiseoperation.exception()orRuntimeError(operation.error_message)ifoperation.warnings:print(f"Warnings during{verbose_name}:\n",file=sys.stderr,flush=True)forwarninginoperation.warnings:print(f" -{warning.code}:{warning.message}",file=sys.stderr,flush=True)returnresultdefcreate_instance(project_id:str,zone:str,instance_name:str,disks:list[compute_v1.AttachedDisk],machine_type:str="n1-standard-1",network_link:str="global/networks/default",subnetwork_link:str=None,internal_ip:str=None,external_access:bool=False,external_ipv4:str=None,accelerators:list[compute_v1.AcceleratorConfig]=None,preemptible:bool=False,spot:bool=False,instance_termination_action:str="STOP",custom_hostname:str=None,delete_protection:bool=False,)->compute_v1.Instance:""" Send an instance creation request to the Compute Engine API and wait for it to complete. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone to create the instance in. For example: "us-west3-b" instance_name: name of the new virtual machine (VM) instance. disks: a list of compute_v1.AttachedDisk objects describing the disks you want to attach to your new instance. machine_type: machine type of the VM being created. This value uses the following format: "zones/{zone}/machineTypes/{type_name}". For example: "zones/europe-west3-c/machineTypes/f1-micro" network_link: name of the network you want the new instance to use. For example: "global/networks/default" represents the network named "default", which is created automatically for each project. subnetwork_link: name of the subnetwork you want the new instance to use. This value uses the following format: "regions/{region}/subnetworks/{subnetwork_name}" internal_ip: internal IP address you want to assign to the new instance. By default, a free address from the pool of available internal IP addresses of used subnet will be used. external_access: boolean flag indicating if the instance should have an external IPv4 address assigned. external_ipv4: external IPv4 address to be assigned to this instance. If you specify an external IP address, it must live in the same region as the zone of the instance. This setting requires `external_access` to be set to True to work. accelerators: a list of AcceleratorConfig objects describing the accelerators that will be attached to the new instance. preemptible: boolean value indicating if the new instance should be preemptible or not. Preemptible VMs have been deprecated and you should now use Spot VMs. spot: boolean value indicating if the new instance should be a Spot VM or not. instance_termination_action: What action should be taken once a Spot VM is terminated. Possible values: "STOP", "DELETE" custom_hostname: Custom hostname of the new VM instance. Custom hostnames must conform to RFC 1035 requirements for valid hostnames. delete_protection: boolean value indicating if the new virtual machine should be protected against deletion or not. Returns: Instance object. """instance_client=compute_v1.InstancesClient()# Use the network interface provided in the network_link argument.network_interface=compute_v1.NetworkInterface()network_interface.network=network_linkifsubnetwork_link:network_interface.subnetwork=subnetwork_linkifinternal_ip:network_interface.network_i_p=internal_ipifexternal_access:access=compute_v1.AccessConfig()access.type_=compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.nameaccess.name="External NAT"access.network_tier=access.NetworkTier.PREMIUM.nameifexternal_ipv4:access.nat_i_p=external_ipv4network_interface.access_configs=[access]# Collect information into the Instance object.instance=compute_v1.Instance()instance.network_interfaces=[network_interface]instance.name=instance_nameinstance.disks=disksifre.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$",machine_type):instance.machine_type=machine_typeelse:instance.machine_type=f"zones/{zone}/machineTypes/{machine_type}"instance.scheduling=compute_v1.Scheduling()ifaccelerators:instance.guest_accelerators=acceleratorsinstance.scheduling.on_host_maintenance=(compute_v1.Scheduling.OnHostMaintenance.TERMINATE.name)ifpreemptible:# Set the preemptible settingwarnings.warn("Preemptible VMs are being replaced by Spot VMs.",DeprecationWarning)instance.scheduling=compute_v1.Scheduling()instance.scheduling.preemptible=Trueifspot:# Set the Spot VM settinginstance.scheduling.provisioning_model=(compute_v1.Scheduling.ProvisioningModel.SPOT.name)instance.scheduling.instance_termination_action=instance_termination_actionifcustom_hostnameisnotNone:# Set the custom hostname for the instanceinstance.hostname=custom_hostnameifdelete_protection:# Set the delete protection bitinstance.deletion_protection=True# Prepare the request to insert an instance.request=compute_v1.InsertInstanceRequest()request.zone=zonerequest.project=project_idrequest.instance_resource=instance# Wait for the create operation to complete.print(f"Creating the{instance_name} instance in{zone}...")operation=instance_client.insert(request=request)wait_for_extended_operation(operation,"instance creation")print(f"Instance{instance_name} created.")returninstance_client.get(project=project_id,zone=zone,instance=instance_name)defcreate_with_existing_disks(project_id:str,zone:str,instance_name:str,disk_names:list[str])->compute_v1.Instance:""" Create a new VM instance using selected disks. The first disk in disk_names will be used as boot disk. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone to create the instance in. For example: "us-west3-b" instance_name: name of the new virtual machine (VM) instance. disk_names: list of disk names to be attached to the new virtual machine. First disk in this list will be used as the boot device. Returns: Instance object. """assertlen(disk_names) >=1disks=[get_disk(project_id,zone,disk_name)fordisk_nameindisk_names]attached_disks=[]fordiskindisks:adisk=compute_v1.AttachedDisk()adisk.source=disk.self_linkattached_disks.append(adisk)attached_disks[0].boot=Trueinstance=create_instance(project_id,zone,instance_name,attached_disks)returninstanceCreate an instance from a boot disk snapshot
If you created a snapshot of the boot disk of a compute instance,you can usethat snapshot to create a new instance.
To quickly create more than one instance with the same boot disk,create a custom image,thencreate instances from that imageinstead of using a snapshot.
To create a compute instance with a regional boot disk that wascreated from a snapshot, use the Google Cloud CLI or REST.
Console
In the Google Cloud console, go to theCreate an instance page.
If prompted, select your project and clickContinue. TheCreate an instance page appears and displays theMachine configuration pane.
In theMachine configuration pane, do the following:
- In theName field, specify a name for your instance. For moreinformation, seeResource naming convention.
Optional: In theZone field, select a zone for this instance.
The default selection isAny. If you don't change this defaultselection, then Google automatically chooses a zone for you based onmachine type and availability.
Select the machine family for your instance. The Google Cloud console thendisplays the machine series that are available for your selectedmachine family. The following machine family options are available:
- General purpose
- Compute optimized
- Memory optimized
- Storage optimized
- GPUs
In theSeries column, select the machine series for your instance.
If you selectedGPUs as the machine family in the previous step,then select theGPU type that you want. The machine series isthen automatically selected for the selected GPU type.
In theMachine type section, select the machine type for your instance.
In the navigation menu, clickOS and storage. In theOperating system and storage pane that appears, configure your bootdisk by doing the following:
- ClickChange. TheBoot disk pane appears and displays thePublic images tab.
- ClickSnapshots. TheSnapshot tab appears.
- In theSnapshot list, select the snapshot to use.
- In theBoot disk type list, select the type of the boot disk.
- In theSize (GB) field, specify the size of the boot disk.
- Optional: For advanced configuration options, expand theShow advanced configurations section.
- To confirm your boot disk options and return to theOperating system and storage pane, clickSelect.
In the navigation menu, clickNetworking. In theNetworking panethat appears, do the following:
- Go to theFirewall section.
- To permit HTTP or HTTPS traffic to the instance, selectAllow HTTP traffic orAllow HTTPS traffic.
The Google Cloud console adds a network tag to your instance andcreates the corresponding ingress firewall rule that allows allincoming traffic on
tcp:80(HTTP) ortcp:443(HTTPS). The networktag associates the firewall rule with the instance. For moreinformation, seeFirewall rules overview inthe Virtual Private Cloud documentation.Optional: Specify other configuration options. For more information, seeConfiguration options during instance creation.
To create and start the instance, clickCreate.
gcloud
Zonal boot disk
Use thegcloud compute instances create command and include the--source-snapshot flag.
gcloud compute instances createINSTANCE_NAME
--source-snapshot=BOOT_SNAPSHOT_NAME
--boot-disk-size=BOOT_DISK_SIZE
--boot-disk-type=BOOT_DISK_TYPE
--boot-disk-device-name=BOOT_DISK_NAME
Replace the following:
INSTANCE_NAME:name for the new instanceBOOT_SNAPSHOT_NAME: name of the boot disk snapshot that you want to restore to the boot disk of the new instanceBOOT_DISK_SIZE: Optional: size, in GiB, of the new boot diskThe size must be equal to or larger than the size of the source disk from which the snapshot was made.
BOOT_DISK_TYPE: Optional:type of the boot disk, for examplePROJECT_ID/zones/ZONE/diskTypes/pd-ssdorPROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balancedBOOT_DISK_NAME: name of the new boot disk for this instance
Regional boot disk
Use thegcloud compute instances create command and include the--create-disk flag with thesource-snapshot,replica-zones, andboot properties.
gcloud compute instances createINSTANCE_NAME
--zone=ZONE
--create-disk=^:^name=DISK_NAME:source-snapshot=BOOT_SNAPSHOT_NAME:boot=true:type=BOOT_DISK_TYPE:replica-zones=ZONE,REMOTE_ZONE
The characters^:^ specify that a colon: is used as the separator between each of the disk properties. This is required so that you can use a comma, when specifying the zones forreplica-zones.
Replace the following:
INSTANCE_NAME:namefor the new instanceZONE: To zone to create the instance inDISK_NAME: Optional: a name for the diskBOOT_SNAPSHOT_NAME: name of the boot disksnapshot that you want to restore to the boot disk of thenew instance.BOOT_DISK_TYPE: Optional:type of the boot disk, forexamplepd-ssdorhyperdisk-balanced-high-availabilityREMOTE_ZONE: The region that the boot disk isreplicated to. Thereplica-zonesproperty requirestwo zones separated by comma, and one of the zones must the sameas the zone for the instance.
Go
Go
Before trying this sample, follow theGo setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineGo API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
import("context""fmt""io"compute"cloud.google.com/go/compute/apiv1"computepb"cloud.google.com/go/compute/apiv1/computepb""google.golang.org/protobuf/proto")// createInstanceFromSnapshot creates a new VM instance with boot disk created from a snapshot.funccreateInstanceFromSnapshot(wio.Writer,projectID,zone,instanceName,snapshotLinkstring)error{// projectID := "your_project_id"// zone := "europe-central2-b"// instanceName := "your_instance_name"// snapshotLink := "projects/project_name/global/snapshots/snapshot_name"ctx:=context.Background()instancesClient,err:=compute.NewInstancesRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewInstancesRESTClient: %w",err)}deferinstancesClient.Close()req:=&computepb.InsertInstanceRequest{Project:projectID,Zone:zone,InstanceResource:&computepb.Instance{Name:proto.String(instanceName),Disks:[]*computepb.AttachedDisk{{InitializeParams:&computepb.AttachedDiskInitializeParams{DiskSizeGb:proto.Int64(11),SourceSnapshot:proto.String(snapshotLink),DiskType:proto.String(fmt.Sprintf("zones/%s/diskTypes/pd-standard",zone)),},AutoDelete:proto.Bool(true),Boot:proto.Bool(true),Type:proto.String(computepb.AttachedDisk_PERSISTENT.String()),},},MachineType:proto.String(fmt.Sprintf("zones/%s/machineTypes/n1-standard-1",zone)),NetworkInterfaces:[]*computepb.NetworkInterface{{Name:proto.String("global/networks/default"),},},},}op,err:=instancesClient.Insert(ctx,req)iferr!=nil{returnfmt.Errorf("unable to create instance: %w",err)}iferr=op.Wait(ctx);err!=nil{returnfmt.Errorf("unable to wait for the operation: %w",err)}fmt.Fprintf(w,"Instance created\n")returnnil}Java
Java
Before trying this sample, follow theJava setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineJava API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
importcom.google.api.gax.longrunning.OperationFuture;importcom.google.cloud.compute.v1.AttachedDisk;importcom.google.cloud.compute.v1.AttachedDisk.Type;importcom.google.cloud.compute.v1.AttachedDiskInitializeParams;importcom.google.cloud.compute.v1.Image;importcom.google.cloud.compute.v1.ImagesClient;importcom.google.cloud.compute.v1.InsertInstanceRequest;importcom.google.cloud.compute.v1.Instance;importcom.google.cloud.compute.v1.InstancesClient;importcom.google.cloud.compute.v1.NetworkInterface;importcom.google.cloud.compute.v1.Operation;importjava.io.IOException;importjava.util.Vector;importjava.util.concurrent.ExecutionException;importjava.util.concurrent.TimeUnit;importjava.util.concurrent.TimeoutException;publicclassCreateInstancesAdvanced{/** * @param diskType the type of disk you want to create. This value uses the following format: * "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example: * "zones/us-west3-b/diskTypes/pd-ssd" * @param diskSizeGb size of the new disk in gigabytes * @param boot boolean flag indicating whether this disk should be used as a boot disk of an * instance * @param diskSnapshot disk snapshot to use when creating this disk. You must have read access to * this disk. This value uses the following format: * "projects/{project_name}/global/snapshots/{snapshot_name}" * @return AttachedDisk object configured to be created using the specified snapshot. */privatestaticAttachedDiskdiskFromSnapshot(StringdiskType,intdiskSizeGb,booleanboot,StringdiskSnapshot){AttachedDiskdisk=AttachedDisk.newBuilder().setBoot(boot)// Remember to set auto_delete to True if you want the disk to be deleted when// you delete your VM instance..setAutoDelete(true).setType(Type.PERSISTENT.toString()).setInitializeParams(AttachedDiskInitializeParams.newBuilder().setSourceSnapshot(diskSnapshot).setDiskSizeGb(diskSizeGb).setDiskType(diskType).build()).build();returndisk;}/** * Send an instance creation request to the Compute Engine API and wait for it to complete. * * @param project project ID or project number of the Cloud project you want to use. * @param zone name of the zone to create the instance in. For example: "us-west3-b" * @param instanceName name of the new virtual machine (VM) instance. * @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach * to your new instance. * @param machineType machine type of the VM being created. This value uses the following format: * "zones/{zone}/machineTypes/{type_name}". * For example: "zones/europe-west3-c/machineTypes/f1-micro" * @param network name of the network you want the new instance to use. For example: * "global/networks/default" represents the network named "default", which is created * automatically for each project. * @param subnetwork name of the subnetwork you want the new instance to use. This value uses the * following format: "regions/{region}/subnetworks/{subnetwork_name}" * @return Instance object. */privatestaticInstancecreateWithDisks(Stringproject,Stringzone,StringinstanceName,Vector<AttachedDisk>disks,StringmachineType,Stringnetwork,Stringsubnetwork)throwsIOException,InterruptedException,ExecutionException,TimeoutException{try(InstancesClientinstancesClient=InstancesClient.create()){// Use the network interface provided in the networkName argument.NetworkInterfacenetworkInterface;if(subnetwork!=null){networkInterface=NetworkInterface.newBuilder().setName(network).setSubnetwork(subnetwork).build();}else{networkInterface=NetworkInterface.newBuilder().setName(network).build();}machineType=String.format("zones/%s/machineTypes/%s",zone,machineType);// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.InstanceinstanceResource=Instance.newBuilder().setName(instanceName).setMachineType(machineType).addAllDisks(disks).addNetworkInterfaces(networkInterface).build();System.out.printf("Creating instance: %s at %s ",instanceName,zone);// Insert the instance in the specified project and zone.InsertInstanceRequestinsertInstanceRequest=InsertInstanceRequest.newBuilder().setProject(project).setZone(zone).setInstanceResource(instanceResource).build();OperationFuture<Operation,Operation>operation=instancesClient.insertAsync(insertInstanceRequest);// Wait for the operation to complete.Operationresponse=operation.get(3,TimeUnit.MINUTES);if(response.hasError()){System.out.println("Instance creation failed ! ! "+response);returnnull;}System.out.println("Operation Status: "+response.getStatus());returninstancesClient.get(project,zone,instanceName);}}/** * Create a new VM instance with boot disk created from a snapshot. * * @param project project ID or project number of the Cloud project you want to use. * @param zone name of the zone to create the instance in. For example: "us-west3-b" * @param instanceName name of the new virtual machine (VM) instance. * @param snapshotName link to the snapshot you want to use as the source of your boot disk in the * form of: "projects/{project_name}/global/snapshots/{snapshot_name}" * @return Instance object. */publicstaticInstancecreateFromSnapshot(Stringproject,Stringzone,StringinstanceName,StringsnapshotName)throwsIOException,InterruptedException,ExecutionException,TimeoutException{StringdiskType=String.format("zones/%s/diskTypes/pd-standard",zone);Vector<AttachedDisk>disks=newVector<>();disks.add(diskFromSnapshot(diskType,11,true,snapshotName));returncreateWithDisks(project,zone,instanceName,disks,"n1-standard-1","global/networks/default",null);}Node.js
Node.js
Before trying this sample, follow theNode.js setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineNode.js API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
/** * TODO(developer): Uncomment and replace these variables before running the sample. */// const projectId = 'YOUR_PROJECT_ID';// const zone = 'europe-central2-b';// const instanceName = 'YOUR_INSTANCE_NAME';// const snapshotLink = 'projects/YOUR_PROJECT/global/snapshots/YOUR_SNAPSHOT_NAME';constcompute=require('@google-cloud/compute');// Creates a new VM instance with boot disk created from a snapshot.asyncfunctioncreateInstanceFromSnapshot(){constinstancesClient=newcompute.InstancesClient();const[response]=awaitinstancesClient.insert({project:projectId,zone,instanceResource:{name:instanceName,disks:[{initializeParams:{diskSizeGb:'11',sourceSnapshot:snapshotLink,diskType:`zones/${zone}/diskTypes/pd-standard`,},autoDelete:true,boot:true,type:'PERSISTENT',},],machineType:`zones/${zone}/machineTypes/n1-standard-1`,networkInterfaces:[{name:'global/networks/default',},],},});letoperation=response.latestResponse;constoperationsClient=newcompute.ZoneOperationsClient();// Wait for the create operation to complete.while(operation.status!=='DONE'){[operation]=awaitoperationsClient.wait({operation:operation.name,project:projectId,zone:operation.zone.split('/').pop(),});}console.log('Instance created.');}createInstanceFromSnapshot();Python
Python
Before trying this sample, follow thePython setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EnginePython API reference documentation.
To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.
from__future__importannotationsimportreimportsysfromtypingimportAnyimportwarningsfromgoogle.api_core.extended_operationimportExtendedOperationfromgoogle.cloudimportcompute_v1defdisk_from_snapshot(disk_type:str,disk_size_gb:int,boot:bool,source_snapshot:str,auto_delete:bool=True,)->compute_v1.AttachedDisk():""" Create an AttachedDisk object to be used in VM instance creation. Uses a disk snapshot as the source for the new disk. Args: disk_type: the type of disk you want to create. This value uses the following format: "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example: "zones/us-west3-b/diskTypes/pd-ssd" disk_size_gb: size of the new disk in gigabytes boot: boolean flag indicating whether this disk should be used as a boot disk of an instance source_snapshot: disk snapshot to use when creating this disk. You must have read access to this disk. This value uses the following format: "projects/{project_name}/global/snapshots/{snapshot_name}" auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it Returns: AttachedDisk object configured to be created using the specified snapshot. """disk=compute_v1.AttachedDisk()initialize_params=compute_v1.AttachedDiskInitializeParams()initialize_params.source_snapshot=source_snapshotinitialize_params.disk_type=disk_typeinitialize_params.disk_size_gb=disk_size_gbdisk.initialize_params=initialize_params# Remember to set auto_delete to True if you want the disk to be deleted when you delete# your VM instance.disk.auto_delete=auto_deletedisk.boot=bootreturndiskdefwait_for_extended_operation(operation:ExtendedOperation,verbose_name:str="operation",timeout:int=300)->Any:""" Waits for the extended (long-running) operation to complete. If the operation is successful, it will return its result. If the operation ends with an error, an exception will be raised. If there were any warnings during the execution of the operation they will be printed to sys.stderr. Args: operation: a long-running operation you want to wait on. verbose_name: (optional) a more verbose name of the operation, used only during error and warning reporting. timeout: how long (in seconds) to wait for operation to finish. If None, wait indefinitely. Returns: Whatever the operation.result() returns. Raises: This method will raise the exception received from `operation.exception()` or RuntimeError if there is no exception set, but there is an `error_code` set for the `operation`. In case of an operation taking longer than `timeout` seconds to complete, a `concurrent.futures.TimeoutError` will be raised. """result=operation.result(timeout=timeout)ifoperation.error_code:print(f"Error during{verbose_name}: [Code:{operation.error_code}]:{operation.error_message}",file=sys.stderr,flush=True,)print(f"Operation ID:{operation.name}",file=sys.stderr,flush=True)raiseoperation.exception()orRuntimeError(operation.error_message)ifoperation.warnings:print(f"Warnings during{verbose_name}:\n",file=sys.stderr,flush=True)forwarninginoperation.warnings:print(f" -{warning.code}:{warning.message}",file=sys.stderr,flush=True)returnresultdefcreate_instance(project_id:str,zone:str,instance_name:str,disks:list[compute_v1.AttachedDisk],machine_type:str="n1-standard-1",network_link:str="global/networks/default",subnetwork_link:str=None,internal_ip:str=None,external_access:bool=False,external_ipv4:str=None,accelerators:list[compute_v1.AcceleratorConfig]=None,preemptible:bool=False,spot:bool=False,instance_termination_action:str="STOP",custom_hostname:str=None,delete_protection:bool=False,)->compute_v1.Instance:""" Send an instance creation request to the Compute Engine API and wait for it to complete. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone to create the instance in. For example: "us-west3-b" instance_name: name of the new virtual machine (VM) instance. disks: a list of compute_v1.AttachedDisk objects describing the disks you want to attach to your new instance. machine_type: machine type of the VM being created. This value uses the following format: "zones/{zone}/machineTypes/{type_name}". For example: "zones/europe-west3-c/machineTypes/f1-micro" network_link: name of the network you want the new instance to use. For example: "global/networks/default" represents the network named "default", which is created automatically for each project. subnetwork_link: name of the subnetwork you want the new instance to use. This value uses the following format: "regions/{region}/subnetworks/{subnetwork_name}" internal_ip: internal IP address you want to assign to the new instance. By default, a free address from the pool of available internal IP addresses of used subnet will be used. external_access: boolean flag indicating if the instance should have an external IPv4 address assigned. external_ipv4: external IPv4 address to be assigned to this instance. If you specify an external IP address, it must live in the same region as the zone of the instance. This setting requires `external_access` to be set to True to work. accelerators: a list of AcceleratorConfig objects describing the accelerators that will be attached to the new instance. preemptible: boolean value indicating if the new instance should be preemptible or not. Preemptible VMs have been deprecated and you should now use Spot VMs. spot: boolean value indicating if the new instance should be a Spot VM or not. instance_termination_action: What action should be taken once a Spot VM is terminated. Possible values: "STOP", "DELETE" custom_hostname: Custom hostname of the new VM instance. Custom hostnames must conform to RFC 1035 requirements for valid hostnames. delete_protection: boolean value indicating if the new virtual machine should be protected against deletion or not. Returns: Instance object. """instance_client=compute_v1.InstancesClient()# Use the network interface provided in the network_link argument.network_interface=compute_v1.NetworkInterface()network_interface.network=network_linkifsubnetwork_link:network_interface.subnetwork=subnetwork_linkifinternal_ip:network_interface.network_i_p=internal_ipifexternal_access:access=compute_v1.AccessConfig()access.type_=compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.nameaccess.name="External NAT"access.network_tier=access.NetworkTier.PREMIUM.nameifexternal_ipv4:access.nat_i_p=external_ipv4network_interface.access_configs=[access]# Collect information into the Instance object.instance=compute_v1.Instance()instance.network_interfaces=[network_interface]instance.name=instance_nameinstance.disks=disksifre.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$",machine_type):instance.machine_type=machine_typeelse:instance.machine_type=f"zones/{zone}/machineTypes/{machine_type}"instance.scheduling=compute_v1.Scheduling()ifaccelerators:instance.guest_accelerators=acceleratorsinstance.scheduling.on_host_maintenance=(compute_v1.Scheduling.OnHostMaintenance.TERMINATE.name)ifpreemptible:# Set the preemptible settingwarnings.warn("Preemptible VMs are being replaced by Spot VMs.",DeprecationWarning)instance.scheduling=compute_v1.Scheduling()instance.scheduling.preemptible=Trueifspot:# Set the Spot VM settinginstance.scheduling.provisioning_model=(compute_v1.Scheduling.ProvisioningModel.SPOT.name)instance.scheduling.instance_termination_action=instance_termination_actionifcustom_hostnameisnotNone:# Set the custom hostname for the instanceinstance.hostname=custom_hostnameifdelete_protection:# Set the delete protection bitinstance.deletion_protection=True# Prepare the request to insert an instance.request=compute_v1.InsertInstanceRequest()request.zone=zonerequest.project=project_idrequest.instance_resource=instance# Wait for the create operation to complete.print(f"Creating the{instance_name} instance in{zone}...")operation=instance_client.insert(request=request)wait_for_extended_operation(operation,"instance creation")print(f"Instance{instance_name} created.")returninstance_client.get(project=project_id,zone=zone,instance=instance_name)defcreate_from_snapshot(project_id:str,zone:str,instance_name:str,snapshot_link:str):""" Create a new VM instance with boot disk created from a snapshot. The new boot disk will have 20 gigabytes. Args: project_id: project ID or project number of the Cloud project you want to use. zone: name of the zone to create the instance in. For example: "us-west3-b" instance_name: name of the new virtual machine (VM) instance. snapshot_link: link to the snapshot you want to use as the source of your boot disk in the form of: "projects/{project_name}/global/snapshots/{snapshot_name}" Returns: Instance object. """disk_type=f"zones/{zone}/diskTypes/pd-standard"disks=[disk_from_snapshot(disk_type,20,True,snapshot_link)]instance=create_instance(project_id,zone,instance_name,disks)returninstanceREST
When you use the API to create an instance from a snapshot, the followingrestrictions apply:
- Only one disk can be used as the boot disk.
- You must attach the boot disk as the first disk for thatinstance.
- If you specify the
sourceproperty, you cannot also specify theinitializeParamsproperty. Providing asourceindicates that theboot disk exists already, but theinitializeParamsproperty indicates that Compute Engine should createa new boot disk.
Zonal boot disk
To create an instance from a boot disk snapshot, use theinstances.insert method and specify thesourceSnapshot field under thedisks property. You can optionally specify thediskSizeGb anddiskType properties for the new boot disk.POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances{ "name": "INSTANCE_NAME", "machineType": "machineTypes/MACHINE_TYPE", "disks": [{ "boot": true, "initializeParams": { "sourceSnapshot": "global/snapshots/BOOT_SNAPSHOT_NAME", "diskSizeGb": "BOOT_DISK_SIZE", "diskType": "BOOT_DISK_TYPE" } }], "networkInterfaces": [ { "nicType": "GVNIC" } ]}PROJECT_ID: your project IDZONE: zone where you want to create the new instanceINSTANCE_NAME:name of the instance that you want to restore a snapshot toMACHINE_TYPE:machine type of the instanceBOOT_SNAPSHOT_NAME: name of the snapshot that you want to use to create the boot disk of the new instanceBOOT_DISK_SIZE: Optional: size, in gibibytes (GiB), for the new boot diskThe size must be equal to or larger than the size of the source disk from which the snapshot was made.
BOOT_DISK_TYPE: Optional:type of the boot disk, for examplePROJECT_ID/zones/ZONE/diskTypes/pd-ssdorPROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balanced
Regional boot disk
To create a compute instance with a regional boot disk using a boot disk snapshot as the source, use theinstances.insert method and specify thesourceSnapshot andreplicaZones fields in thedisks property. POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances { "name": "INSTANCE_NAME", "disks": [ { "boot": true, "initializeParams": { "sourceSnapshot": "global/snapshots/BOOT_SNAPSHOT_NAME", "replicaZones": [ "projects/PROJECT_ID/zones/ZONE", "projects/PROJECT_ID/zones/REMOTE_ZONE" ], "diskType": "BOOT_DISK_TYPE" } } ], "networkInterfaces": [ { "nicType": "GVNIC" } ] }Replace the following:
PROJECT_ID: your project IDZONE: the name of the zone where you want to create the instanceINSTANCE_NAME`: a name for the instanceBOOT_SNAPSHOT_NAME: the name of the boot disk snapshotREMOTE_ZONE: the remote zone for the regional diskBOOT_DISK_TYPE: Optional:type of the boot disk, for examplePROJECT_ID/zones/ZONE/diskTypes/pd-ssdorPROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balanced-high-availability
Create a compute instance from a non-boot disk snapshot
If you backed up a non-boot disk with a snapshot, you can create an instancewith an additional non-boot disk based on the snapshot.
Console
When restoring non-boot snapshots to a new instance from the console,first create a disk from each snapshot. Then, attach the new disks whenyou create the instance.
Restore each non-boot snapshot to a new disk.
In the Google Cloud console, go to theDisks page.
ClickCreate disk.
Specify aName for your disk. For more information, seeResource naming convention.
Select theRegion andZone for this disk. The disk andinstance must be in the same zone for zonal disks, or region forregional disks.
Select a diskType.
UnderSource type, selectSnapshot.
Under the newSource snapshot field, select a non-bootsnapshot that you want to restore to the new disk.
To create the disk, clickCreate.
Repeat these steps to create a disk from each snapshot that you wantto restore.
In the Google Cloud console, go to theVM instances page.
Select your project and clickContinue.
ClickCreate instance.
Specify aName for your instance. For more information, seeResource naming convention.
Select theRegion andZone for this instance. The disk andinstance must be in the same zone for zonal disks, or region forregional disks.
Select aMachine type for your instance.
If you want to allow incoming external traffic, change theFirewallrules for the instance.
To attach disks to the instance, expand theAdvanced options section, and then do the following:
- Expand theDisks section.
- ClickAttach existing disk.
- In theDisk list, select a disk to attach to this instance.
- In theAttachment Setting section, select disk's attachmentMode and theDeletion rule. For more information aboutadding new disks, seeAdd a Persistent DiskorAdd Hyperdisk.
- ClickSave.
Repeat these steps for each disk that you want to attach.
To create and start the instance, clickCreate.
gcloud
Create an instance by using thegcloud compute instances create command.For each non-boot snapshot that you want to restore, include the--create-disk flag, and specify asource-snapshot.
For example, to restore two snapshots of non-boot disks to a new instance,use the following command:
gcloud compute instances createINSTANCE_NAME \ --create-disk source-snapshot=SNAPSHOT_1_NAME,name=DISK_1_NAME,size=DISK_1_SIZE,type=DISK_1_TYPE \ --create-disk source-snapshot=SNAPSHOT_2_NAME,name=DISK_2_NAME,size=DISK_2_SIZE,type=DISK_2_TYPE
Replace the following:
INSTANCE_NAME:name for the newinstanceSNAPSHOT_1_NAMEandSNAPSHOT_2_NAME: names of the non-boot disksnapshots that you want to restoreDISK_1_NAMEandDISK_2_NAME: names of the new non-boot disksto create for this instanceDISK_1_SIZEandDISK_2_SIZE: Optional: sizes, in gibibytes (GiB),of each new non-boot diskThe sizes must be equal to or larger than thesizes of the source disks from which the snapshot was made.
DISK_1_TYPEandDISK_2_TYPE: Optional: the disktypes to create, for examplepd-ssdorhyperdisk-balanced
REST
When using REST to restore a non-boot snapshot to a new instance,the following restrictions apply:
- Only one disk can be the boot disk.
- You must attach the boot disk as the first disk for that instance.
- If you specify the
sourceproperty, you can't also specify theinitializeParamsproperty. Providing asourceindicates that theboot disk exists already, but theinitializeParamsproperty indicates that Compute Engine should createa new boot disk.
Create aPOST request to theinstances.insert methodand specify thesourceSnapshot field under theinitializeParamsproperty. You can add multiple non-boot disksby repeating theinitializeParams property for every non-boot disk thatyou want to create. You can optionally specify thediskSizeGb anddiskType properties for any of the disks that you create.
For example, to restore two non-boot disk snapshots to a new instance,make the following request:
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances{ "name": "INSTANCE_NAME", "machineType": "machineTypes/MACHINE_TYPE", "networkInterfaces": [ { "nicType": "GVNIC" } ], "disks": [ { "autoDelete": "true", "boot": "true", "diskSizeGb": "BOOT_DISK_SIZE", "diskType": "BOOT_DISK_TYPE", "initializeParams": { "sourceImage": "projects/IMAGE_PROJECT/global/images/family/IMAGE_FAMILY" } }, { "deviceName": "DEVICE_1_NAME", "initializeParams": { "sourceSnapshot": "global/snapshots/SNAPSHOT_1_NAME", "diskSizeGb": "DISK_1_SIZE", "diskType": "DISK_1_TYPE" } }, { "deviceName": "DEVICE_2_NAME", "initializeParams": { "sourceSnapshot": "global/snapshots/SNAPSHOT_2_NAME", "diskSizeGb": "DISK_2_SIZE", "diskType": "DISK_2_TYPE" } } ]}Replace the following:
PROJECT_ID: your project IDZONE: zone where you want to create the instanceINSTANCE_NAME: aname for thenew instanceMACHINE_TYPE:machine type of the instanceDISK_SIZE: Optional: size, in gibibytes (GiB),of the corresponding diskWhen provided, this property must be equal toor larger than the size of the source disk from which the snapshot wasmade.
DISK_TYPE: Optional: full or partial URL forthetype of the correspondingdisk, for example,PROJECT_ID/zones/ZONE/diskTypes/pd-ssdorPROJECT_ID/zones/ZONE/diskTypes/hyperdisk-balancedIMAGE_PROJECT: the project containing the image. Forexample,debian-cloudIMAGE_FAMILY: an image family. This creates the instancefrom the most recent, non-deprecated OS image in that family. Forexample, if you specify"sourceImage": "projects/debian-cloud/global/images/family/debian-11",the Compute Engine creates an instance using the latest versionof the OS image in the Debian 11 image family.DEVICE_NAME: Optional: thedevice name displayed in theguest OS of the instanceSNAPSHOT_NAME: the names of correspondingnon-boot disk snapshots that you want to restore to new disks on theinstance
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-15 UTC.