Create a zonal or a regional snapshot of a disk in the specified Cloud Storage location.
Explore further
For detailed documentation that includes this code sample, see the following:
- Back up your data by using a snapshot
- Create archive and standard disk snapshots
- Move a VM instance between zones or regions
Code sample
Go
Before trying this sample, follow the Go setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Go API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set 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"
)
// createSnapshot creates a snapshot of a disk.
func
createSnapshot
(
w
io
.
Writer
,
projectID
,
diskName
,
snapshotName
,
zone
,
region
,
location
,
diskProjectID
string
,
)
error
{
// projectID := "your_project_id"
// diskName := "your_disk_name"
// snapshotName := "your_snapshot_name"
// zone := "europe-central2-b"
// region := "eupore-central2"
// location = "eupore-central2"
// diskProjectID = "YOUR_DISK_PROJECT_ID"
ctx
:=
context
.
Background
()
snapshotsClient
,
err
:=
compute
.
NewSnapshotsRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewSnapshotsRESTClient: %w"
,
err
)
}
defer
snapshotsClient
.
Close
()
if
zone
==
""
&&
region
==
""
{
return
fmt
.
Errorf
(
"you need to specify `zone` or `region` for this function to work"
)
}
if
zone
!=
""
&&
region
!=
""
{
return
fmt
.
Errorf
(
"you can't set both `zone` and `region` parameters"
)
}
if
diskProjectID
==
""
{
diskProjectID
=
projectID
}
disk
:=
& computepb
.
Disk
{}
locations
:=
[]
string
{}
if
location
!=
""
{
locations
=
append
(
locations
,
location
)
}
if
zone
!=
""
{
disksClient
,
err
:=
compute
.
NewDisksRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewDisksRESTClient: %w"
,
err
)
}
defer
disksClient
.
Close
()
getDiskReq
:=
& computepb
.
GetDiskRequest
{
Project
:
projectID
,
Zone
:
zone
,
Disk
:
diskName
,
}
disk
,
err
=
disksClient
.
Get
(
ctx
,
getDiskReq
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to get disk: %w"
,
err
)
}
}
else
{
regionDisksClient
,
err
:=
compute
.
NewRegionDisksRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewRegionDisksRESTClient: %w"
,
err
)
}
defer
regionDisksClient
.
Close
()
getDiskReq
:=
& computepb
.
GetRegionDiskRequest
{
Project
:
projectID
,
Region
:
region
,
Disk
:
diskName
,
}
disk
,
err
=
regionDisksClient
.
Get
(
ctx
,
getDiskReq
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to get disk: %w"
,
err
)
}
}
req
:=
& computepb
.
InsertSnapshotRequest
{
Project
:
projectID
,
SnapshotResource
:
& computepb
.
Snapshot
{
Name
:
proto
.
String
(
snapshotName
),
SourceDisk
:
proto
.
String
(
disk
.
GetSelfLink
()),
StorageLocations
:
locations
,
},
}
op
,
err
:=
snapshotsClient
.
Insert
(
ctx
,
req
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to create snapshot: %w"
,
err
)
}
if
err
=
op
.
Wait
(
ctx
);
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to wait for the operation: %w"
,
err
)
}
fmt
.
Fprintf
(
w
,
"Snapshot created\n"
)
return
nil
}
Java
Before trying this sample, follow the Java setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Java API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
com.google.cloud.compute.v1. Disk
;
import
com.google.cloud.compute.v1. DisksClient
;
import
com.google.cloud.compute.v1. Operation
;
import
com.google.cloud.compute.v1. RegionDisksClient
;
import
com.google.cloud.compute.v1. Snapshot
;
import
com.google.cloud.compute.v1. SnapshotsClient
;
import
java.io.IOException
;
import
java.util.concurrent.ExecutionException
;
import
java.util.concurrent.TimeUnit
;
import
java.util.concurrent.TimeoutException
;
public
class
CreateSnapshot
{
public
static
void
main
(
String
[]
args
)
throws
IOException
,
ExecutionException
,
InterruptedException
,
TimeoutException
{
// TODO(developer): Replace these variables before running the sample.
// You need to pass `zone` or `region` parameter relevant to the disk you want to
// snapshot, but not both. Pass `zone` parameter for zonal disks and `region` for
// regional disks.
// Project ID or project number of the Cloud project you want to use.
String
projectId
=
"YOUR_PROJECT_ID"
;
// Name of the disk you want to create.
String
diskName
=
"YOUR_DISK_NAME"
;
// Name of the snapshot that you want to create.
String
snapshotName
=
"YOUR_SNAPSHOT_NAME"
;
// The zone of the source disk from which you create the snapshot (for zonal disks).
String
zone
=
"europe-central2-b"
;
// The region of the source disk from which you create the snapshot (for regional disks).
String
region
=
"your-disk-region"
;
// The Cloud Storage multi-region or the Cloud Storage region where you
// want to store your snapshot.
// You can specify only one storage location. Available locations:
// https://cloud.google.com/storage/docs/locations#available-locations
String
location
=
"europe-central2"
;
// Project ID or project number of the Cloud project that
// hosts the disk you want to snapshot. If not provided, the value will be defaulted
// to 'projectId' value.
String
diskProjectId
=
"YOUR_DISK_PROJECT_ID"
;
createSnapshot
(
projectId
,
diskName
,
snapshotName
,
zone
,
region
,
location
,
diskProjectId
);
}
// Creates a snapshot of a disk.
public
static
void
createSnapshot
(
String
projectId
,
String
diskName
,
String
snapshotName
,
String
zone
,
String
region
,
String
location
,
String
diskProjectId
)
throws
IOException
,
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 `snapshotsClient.close()` method on the client to safely
// clean up any remaining background resources.
try
(
SnapshotsClient
snapshotsClient
=
SnapshotsClient
.
create
())
{
if
(
zone
.
isEmpty
()
&&
region
.
isEmpty
())
{
throw
new
Error
(
"You need to specify 'zone' or 'region' for this function to work"
);
}
if
(
!
zone
.
isEmpty
()
&&
!
region
.
isEmpty
())
{
throw
new
Error
(
"You can't set both 'zone' and 'region' parameters"
);
}
// If Disk's project id is not specified, then the projectId parameter will be used.
if
(
diskProjectId
.
isEmpty
())
{
diskProjectId
=
projectId
;
}
// If zone is not empty, use the DisksClient to create a disk.
// Else, use the RegionDisksClient.
Disk
disk
;
if
(
!
zone
.
isEmpty
())
{
DisksClient
disksClient
=
DisksClient
.
create
();
disk
=
disksClient
.
get
(
projectId
,
zone
,
diskName
);
}
else
{
RegionDisksClient
regionDisksClient
=
RegionDisksClient
.
create
();
disk
=
regionDisksClient
.
get
(
diskProjectId
,
region
,
diskName
);
}
// Set the snapshot properties.
Snapshot
snapshotResource
;
if
(
!
location
.
isEmpty
())
{
snapshotResource
=
Snapshot
.
newBuilder
()
.
setName
(
snapshotName
)
.
setSourceDisk
(
disk
.
getSelfLink
())
.
addStorageLocations
(
location
)
.
build
();
}
else
{
snapshotResource
=
Snapshot
.
newBuilder
()
.
setName
(
snapshotName
)
.
setSourceDisk
(
disk
.
getSelfLink
())
.
build
();
}
// Wait for the operation to complete.
Operation
operation
=
snapshotsClient
.
insertAsync
(
projectId
,
snapshotResource
)
.
get
(
3
,
TimeUnit
.
MINUTES
);
if
(
operation
.
hasError
())
{
System
.
out
.
println
(
"Snapshot creation failed!"
+
operation
);
return
;
}
// Retrieve the created snapshot.
Snapshot
snapshot
=
snapshotsClient
.
get
(
projectId
,
snapshotName
);
System
.
out
.
printf
(
"Snapshot created: %s"
,
snapshot
.
getName
());
}
}
}
Node.js
Before trying this sample, follow the Node.js setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Node.js API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
/**
* TODO(developer): Uncomment and replace these variables before running the sample.
*/
// const projectId = 'YOUR_PROJECT_ID';
// const diskName = 'YOUR_DISK_NAME';
// const snapshotName = 'YOUR_SNAPSHOT_NAME';
// const zone = 'europe-central2-b';
// const region = '';
// const location = 'europe-central2';
// let diskProjectId = 'YOUR_DISK_PROJECT_ID';
const
compute
=
require
(
' @google-cloud/compute
'
);
async
function
createSnapshot
()
{
const
snapshotsClient
=
new
compute
.
SnapshotsClient
();
let
disk
;
if
(
!
zone
&&
!
region
)
{
throw
new
Error
(
'You need to specify `zone` or `region` for this function to work.'
);
}
if
(
zone
&&
region
)
{
throw
new
Error
(
"You can't set both `zone` and `region` parameters"
);
}
if
(
!
diskProjectId
)
{
diskProjectId
=
projectId
;
}
if
(
zone
)
{
const
disksClient
=
new
compute
.
DisksClient
();
[
disk
]
=
await
disksClient
.
get
({
project
:
diskProjectId
,
zone
,
disk
:
diskName
,
});
}
else
{
const
regionDisksClient
=
new
compute
.
RegionDisksClient
();
[
disk
]
=
await
regionDisksClient
.
get
({
project
:
diskProjectId
,
region
,
disk
:
diskName
,
});
}
const
snapshotResource
=
{
name
:
snapshotName
,
sourceDisk
:
disk
.
selfLink
,
};
if
(
location
)
{
snapshotResource
.
storageLocations
=
[
location
];
}
const
[
response
]
=
await
snapshotsClient
.
insert
({
project
:
projectId
,
snapshotResource
,
});
let
operation
=
response
.
latestResponse
;
const
operationsClient
=
new
compute
.
GlobalOperationsClient
();
// Wait for the create snapshot operation to complete.
while
(
operation
.
status
!==
'DONE'
)
{
[
operation
]
=
await
operationsClient
.
wait
({
operation
:
operation
.
name
,
project
:
projectId
,
});
}
console
.
log
(
'Snapshot created.'
);
}
createSnapshot
();
Python
Before trying this sample, follow the Python setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Python API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
from
__future__
import
annotations
import
sys
from
typing
import
Any
from
google.api_core.extended_operation
import
ExtendedOperation
from
google.cloud
import
compute_v1
def
wait_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
)
if
operation
.
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
)
raise
operation
.
exception
()
or
RuntimeError
(
operation
.
error_message
)
if
operation
.
warnings
:
print
(
f
"Warnings during
{
verbose_name
}
:
\n
"
,
file
=
sys
.
stderr
,
flush
=
True
)
for
warning
in
operation
.
warnings
:
print
(
f
" -
{
warning
.
code
}
:
{
warning
.
message
}
"
,
file
=
sys
.
stderr
,
flush
=
True
)
return
result
def
create_snapshot
(
project_id
:
str
,
disk_name
:
str
,
snapshot_name
:
str
,
*
,
zone
:
str
|
None
=
None
,
region
:
str
|
None
=
None
,
location
:
str
|
None
=
None
,
disk_project_id
:
str
|
None
=
None
,
)
-
> compute_v1
.
Snapshot
:
"""
Create a snapshot of a disk.
You need to pass `zone` or `region` parameter relevant to the disk you want to
snapshot, but not both. Pass `zone` parameter for zonal disks and `region` for
regional disks.
Args:
project_id: project ID or project number of the Cloud project you want
to use to store the snapshot.
disk_name: name of the disk you want to snapshot.
snapshot_name: name of the snapshot to be created.
zone: name of the zone in which is the disk you want to snapshot (for zonal disks).
region: name of the region in which is the disk you want to snapshot (for regional disks).
location: The Cloud Storage multi-region or the Cloud Storage region where you
want to store your snapshot.
You can specify only one storage location. Available locations:
https://cloud.google.com/storage/docs/locations#available-locations
disk_project_id: project ID or project number of the Cloud project that
hosts the disk you want to snapshot. If not provided, will look for
the disk in the `project_id` project.
Returns:
The new snapshot instance.
"""
if
zone
is
None
and
region
is
None
:
raise
RuntimeError
(
"You need to specify `zone` or `region` for this function to work."
)
if
zone
is
not
None
and
region
is
not
None
:
raise
RuntimeError
(
"You can't set both `zone` and `region` parameters."
)
if
disk_project_id
is
None
:
disk_project_id
=
project_id
if
zone
is
not
None
:
disk_client
=
compute_v1
.
DisksClient
()
disk
=
disk_client
.
get
(
project
=
disk_project_id
,
zone
=
zone
,
disk
=
disk_name
)
else
:
regio_disk_client
=
compute_v1
.
RegionDisksClient
()
disk
=
regio_disk_client
.
get
(
project
=
disk_project_id
,
region
=
region
,
disk
=
disk_name
)
snapshot
=
compute_v1
.
Snapshot
()
snapshot
.
source_disk
=
disk
.
self_link
snapshot
.
name
=
snapshot_name
if
location
:
snapshot
.
storage_locations
=
[
location
]
snapshot_client
=
compute_v1
.
SnapshotsClient
()
operation
=
snapshot_client
.
insert
(
project
=
project_id
,
snapshot_resource
=
snapshot
)
wait_for_extended_operation
(
operation
,
"snapshot creation"
)
return
snapshot_client
.
get
(
project
=
project_id
,
snapshot
=
snapshot_name
)
Terraform
To learn how to apply or remove a Terraform configuration, see Basic Terraform commands . For more information, see the Terraform provider reference documentation .
resource
"google_compute_snapshot"
"snapdisk"
{
name
=
"snapshot-name"
source_disk
=
google_compute_disk.default.name
zone
=
"us-central1-a"
}
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
