Suspend or resume a Compute Engine instance

Linux Windows

This document explains how to suspend or resume Compute Engine instances. To learn more about suspending, stopping, or resetting instances, see Suspend, stop, or reset Compute Engine instances .

If you want to keep your Compute Engine instance around, but you don't want to incur charges for it when the instance isn't in use, then you can suspend the instance. Suspending an instance preserves the instance and migrates the contents of the instance's memory to storage. After resuming the instance, Compute Engine migrates the instance's memory from storage back to the instance, and the instance starts running again.

Suspending a Compute Engine instance is useful for the following:

Development and test environments that are not being fully used during off periods, such as during evenings or weekends, and that you want to maintain for costs saving or faster initialization than creating new instances.
Applications that require a long period of initialization after the instance has finished booting, but before the application is ready to service its first request, such as virtual developer workstations or complex Java applications.

Before you begin

If you haven't already, set up authentication . 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
1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
  gcloud init
  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 running gcloud components update .
2. 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.
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.
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.
For more information, see Set up authentication for a local development environment .
PHP

To use the PHP 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.
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.
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.
For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Required roles

To get the permissions that you need to suspend or resume a compute instance, ask your administrator to grant you the Compute Instance Admin (v1) ( roles/compute.instanceAdmin.v1 ) IAM role on the instance. For more information about granting roles, see Manage access to projects, folders, and organizations .

This predefined role contains the permissions required to suspend or resume a compute instance. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

The following permissions are required to suspend or resume a compute instance:

To suspend an instance: compute.instances.suspend
To resume an instance: compute.instances.resume

You might also be able to get these permissions with custom roles or other predefined roles .

Limitations

When suspending a compute instance, the following limitations apply:

You can only suspend an instance if the guest OS supports it. For more information, see Operating system details .
You can only suspend an instance that uses Debian 8 or 9 as guest OS if you configure the OS before suspending the instance.
You can only suspend an instance for up to 60 days before Compute Engine automatically transitions its state to TERMINATED .
You can suspend Spot VMs or preemptible instances—however, if Compute Engine preempts the instance before the suspend operation completes, Compute Engine ends the suspend operation and preempts the instances.
You can't suspend instances with GPUs attached.
You can't suspend bare metal instances.
You can't suspend Confidential VMs.
You can't suspend instances by using the standard processes that are built into their guest environment. Commands such as systemctl suspend in Ubuntu 16.04 or later, aren't supported. If called, then Compute Engine ignores the in-guest signal.
You can't suspend instances that have CSEK-protected disks attached.

Enable suspend operations in Debian 8 or 9

If a compute instance is running Debian 8 and 9 as its guest OS, then, before suspending the instance, you must enable suspend and resume operations by doing one of the following:

Recommended: Configure the ACPID
Install D-Bus

Configure the ACPID

To enable the suspend and resume operation in Debian 8 or 9, you can configure the Advanced Configuration and Power Interface events Daemon (ACPID) to handle the sleep button event. After enabling the deep sleep button event, you can add a shell script for handling the sleep event as described in this section.

To configure the ACPID to support suspend and resume operations, do the following:

If you haven't already, then connect to your Linux instance .
Create the events folder in the acpi folder:
```
 sudo mkdir -p /etc/acpi/events/ 
```

Configure the ACPID to handle the sleep button event:

 cat <<EOF | sudo tee /etc/acpi/events/sleepbtn-acpi-support
event=button[ /]sleep
action=/etc/acpi/sleepbtn-acpi-support.sh
EOF

Create the sleep event handling script:

 cat <<EOF | sudo tee /etc/acpi/sleepbtn-acpi-support.sh
#!/bin/sh
echo mem > /sys/power/state
EOF

Set up the permissions for the script:

 sudo chmod 755 /etc/acpi/sleepbtn-acpi-support.sh

To make the changes effective, restart the ACPID:
```
 sudo systemctl restart acpid.service 
```

Install D-Bus

To enable the suspend and resume operation in Debian 8 or 9, you can install D-Bus .

To install D-Bus in your compute instance's guest OS when the OS is using Debian 8 or 9, do the following:

If you haven't already, then connect to your Linux instance .
Install D-Bus:
```
 sudo apt-get install dbus 
```

To make the changes effective, restart logind :

 sudo systemctl restart systemd-logind.service

Suspend an instance

If the guest OS of your compute instance is using Debian 8 or 9, then, before suspending the instance, you must configure the guest OS to support suspend and resume operations as described in this document.

To suspend an instance, use of the following methods based on whether the instance has Local SSD disks attached:

If your instance doesn't have any Local SSD disks attached, then see Suspend an instance without Local SSD disks .
If your instance has any Local SSD disks attached, and you want to either discard or preserve ( Preview ) the disks' Local SSD data, then see Suspend an instance with Local SSD disks .

Suspend an instance without Local SSD disks

You can suspend multiple compute instances simultaneously or individual instances. For multiple instances, use the Google Cloud console or, for instances located in the same zone, the Google Cloud CLI. For individual instances, select any of the following options:

Console

In the Google Cloud console, go to the VM instancespage.

Go to VM instances
Select one or more instances to suspend.
Click Suspend, and then click Suspendto confirm.

gcloud

To suspend one or more instances in a single zone, use the gcloud compute instances suspend command :

 gcloud compute instances suspend INSTANCE_NAMES 
\
    --zone= ZONE

Replace the following:

INSTANCE_NAMES : a whitespace-separated list of names of instances—for example, instance-01 instance-02 instance-03 .
ZONE : the zone where the instances are located.

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // suspendInstance suspends a running Google Compute Engine instance. 
 func 
  
 suspendInstance 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 zone 
 , 
  
 instanceName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // zone := "europe-central2-b" 
  
 // instanceName := "your_instance_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 instancesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewInstancesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewInstancesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 instancesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 SuspendInstanceRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Zone 
 : 
  
 zone 
 , 
  
 Instance 
 : 
  
 instanceName 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 instancesClient 
 . 
  Suspend 
 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to suspend instance: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Instance suspended\n" 
 ) 
  
 return 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Instance 
. Status 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InstancesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Operation 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 SuspendInstance 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // project: project ID or project number of the Cloud project your instance belongs to. 
  
 // zone: name of the zone your instance belongs to. 
  
 // instanceName: name of the instance your want to suspend. 
  
 String 
  
 project 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 zone 
  
 = 
  
 "zone-name" 
 ; 
  
 String 
  
 instanceName 
  
 = 
  
 "instance-name" 
 ; 
  
 suspendInstance 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ); 
  
 } 
  
 // Suspend a running Google Compute Engine instance. 
  
 // For limitations and compatibility on which instances can be suspended, 
  
 // see: https://cloud.google.com/compute/docs/instances/suspend-resume-instance#limitations 
  
 public 
  
 static 
  
 void 
  
 suspendInstance 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 zone 
 , 
  
 String 
  
 instanceName 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // Instantiates a client. 
  
 try 
  
 ( 
  InstancesClient 
 
  
 instancesClient 
  
 = 
  
  InstancesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  Operation 
 
  
 operation 
  
 = 
  
 instancesClient 
 . 
  suspendAsync 
 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ) 
  
 . 
 get 
 ( 
 300 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 if 
  
 ( 
 operation 
 . 
  hasError 
 
 () 
  
 || 
  
 ! 
 instancesClient 
 . 
 get 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ). 
 getStatus 
 () 
  
 . 
 equalsIgnoreCase 
 ( 
  Status 
 
 . 
 SUSPENDED 
 . 
 toString 
 ())) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Cannot suspend instance. Try again!" 
 ); 
  
 return 
 ; 
  
 } 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Instance suspended successfully ! %s" 
 , 
  
 instanceName 
 ); 
  
 } 
  
 } 
 }

Node.js

  /** 
 * 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 
  
 compute 
  
 = 
  
 require 
 ( 
 ' @google-cloud/compute 
' 
 ); 
 // Suspends a running Google Compute Engine instance. 
 async 
  
 function 
  
 suspendInstance 
 () 
  
 { 
  
 const 
  
 instancesClient 
  
 = 
  
 new 
  
 compute 
 . 
  InstancesClient 
 
 (); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 instancesClient 
 . 
 suspend 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 , 
  
 instance 
 : 
  
 instanceName 
 , 
  
 }); 
  
 let 
  
 operation 
  
 = 
  
 response 
 . 
 latestResponse 
 ; 
  
 const 
  
 operationsClient 
  
 = 
  
 new 
  
 compute 
 . 
  ZoneOperationsClient 
 
 (); 
  
 // Wait for the create operation to complete. 
  
 while 
  
 ( 
 operation 
 . 
 status 
  
 !== 
  
 'DONE' 
 ) 
  
 { 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 operationsClient 
 . 
 wait 
 ({ 
  
 operation 
 : 
  
 operation 
 . 
 name 
 , 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 : 
  
 operation 
 . 
 zone 
 . 
 split 
 ( 
 '/' 
 ). 
 pop 
 (), 
  
 }); 
  
 } 
  
 console 
 . 
 log 
 ( 
 'Instance suspended.' 
 ); 
 } 
 suspendInstance 
 ();

PHP

  use Google\Cloud\Compute\V1\Client\InstancesClient; 
 use Google\Cloud\Compute\V1\SuspendInstanceRequest; 
 /** 
 * Suspend a running Google Compute Engine instance. 
 * 
 * @param string $projectId Project ID or project number of the Cloud project your instance belongs to. 
 * @param string $zone Name of the zone your instance belongs to. 
 * @param string $instanceName Name of the instance you want to suspend. 
 * 
 * @throws \Google\ApiCore\ApiException if the remote call fails. 
 * @throws \Google\ApiCore\ValidationException if local error occurs before remote call. 
 */ 
 function suspend_instance( 
 string $projectId, 
 string $zone, 
 string $instanceName 
 ) { 
 // Suspend the running Compute Engine instance using InstancesClient. 
 $instancesClient = new InstancesClient(); 
 $request = (new SuspendInstanceRequest()) 
 ->setInstance($instanceName) 
 ->setProject($projectId) 
 ->setZone($zone); 
 $operation = $instancesClient->suspend($request); 
 // Wait for the operation to complete. 
 $operation->pollUntilComplete(); 
 if ($operation->operationSucceeded()) { 
 printf('Instance %s suspended successfully' . PHP_EOL, $instanceName); 
 } else { 
 $error = $operation->getError(); 
 printf('Failed to suspend instance: %s' . PHP_EOL, $error?->getMessage()); 
 } 
 }

Python

  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 
  
 suspend_instance 
 ( 
 project_id 
 : 
 str 
 , 
 zone 
 : 
 str 
 , 
 instance_name 
 : 
 str 
 ) 
 - 
> None 
 : 
  
 """ 
 Suspend a running Google Compute Engine instance. 
 Args: 
 project_id: project ID or project number of the Cloud project your instance belongs to. 
 zone: name of the zone your instance belongs to. 
 instance_name: name of the instance you want to suspend. 
 """ 
 instance_client 
 = 
  compute_v1 
 
 . 
  InstancesClient 
 
 () 
 operation 
 = 
 instance_client 
 . 
  suspend 
 
 ( 
 project 
 = 
 project_id 
 , 
 zone 
 = 
 zone 
 , 
 instance 
 = 
 instance_name 
 ) 
 wait_for_extended_operation 
 ( 
 operation 
 , 
 "suspend instance" 
 )

REST

To suspend an instance, make a POST request to the instances.suspend method :

 POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/zones/ ZONE 
/instances/ INSTANCE_NAME 
/suspend

Replace the following:

PROJECT_ID : the ID of the project where the instance is located.
ZONE : the zone where the instance is located.
INSTANCE_NAME : the name of the instance.

Suspend an instance with Local SSD disks

Based on how many compute instances you want to suspend simultaneously and whether you need to preserve the data of their attached Local SSD disks, do the following:

To preserve the data of the Local SSD disks attached to an instance (excluding Z3 instances), suspend the instance using the gcloud CLI or REST API.

Caution: Compute Engine uses persistent storage to store your Local SSD data. Before suspending an instance, ensure that you have enough quota for the storage space used. Otherwise, suspending the instance fails. For more information, see Stop or suspend a VM with Local SSD disks .
To suspend multiple instances simultaneously, use the Google Cloud console or, for instances located in the same zone, the gcloud CLI.

To suspend one or more instances that have Local SSD disks attached, select one of the following options:

Console

In the Google Cloud console, go to the VM instancespage.

Go to VM instances
Select one or more instances to suspend.
Click Suspend, and then click Suspendto confirm.

gcloud

When suspending one or more instances in a single zone that have Local SSD disks attached, specify whether to discard or preserve Local SSD data as follows:

To discard Local SSD data, use the gcloud compute instances suspend command with the --discard-local-ssd=true flag:

 gcloud compute instances suspend INSTANCE_NAMES 
\
    --discard-local-ssd=true \
    --zone= ZONE

To preserve Local SSD data, use the gcloud beta compute instances suspend command with the --discard-local-ssd=false flag:

Preview — The --discard-local-ssd=false flag

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms . Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions .
```
 gcloud beta compute instances suspend INSTANCE_NAMES 
\
    --discard-local-ssd=false \
    --zone= ZONE 
 
```

Replace the following:

INSTANCE_NAMES : a whitespace-separated list of names of instances—for example, instance-01 instance-02 instance-03 .
ZONE : the zone where the instances are located.

REST

When suspending an instance that has Local SSD disks attached, specify whether to discard or preserve Local SSD data as follows:

To discard Local SSD data, make a POST request to the instances.suspend method . In the request URL, include the discardLocalSsd query parameter set to true :

 POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/zones/ ZONE 
/instances/ INSTANCE_NAME 
/suspend?discardLocalSsd=true

To preserve Local SSD data, make a POST request to the beta.instances.suspend method . In the request URL, include the discardLocalSsd query parameter set to false :

Preview — The discardLocalSsd=false query parameter

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms . Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions .
```
 POST https://compute.googleapis.com/compute/beta/projects/ PROJECT_ID 
/zones/ ZONE 
/instances/ INSTANCE_NAME 
/suspend?discardLocalSsd=false 
```

Replace the following:

PROJECT_ID : the ID of the project where the instance is located.
ZONE : the zone where the instance is located.
INSTANCE_NAME : the name of the instance.

Resume a suspended instance

Before resuming a suspended compute instance, consider the following:

You can resume an instance only if there is sufficient capacity in the zone where the instance is located. This isn't usually a problem. If you have troubles resuming an instance, then try again later.
If you attached Local SSD disks to the instance and chose to preserve Local SSD data when suspending it, then you might need to remount the Local SSD disks after resuming it. For more information, see how to remount non-boot disks on Linux instances or Windows instances .

You can resume multiple instances simultaneously or individual instances. For multiple instances, use the Google Cloud console or, for instances located in the same zone, the gcloud CLI. For individual instances, select any of the following options:

Console

In the Google Cloud console, go to the VM instancespage.

Go to VM instances
Select one or more suspended instances to resume.
Click Start / Resume, and then click Start.

gcloud

To resume one or more suspended instances in a single zone, use the gcloud compute instances resume command :

 gcloud compute instances resume INSTANCE_NAMES 
\
    --zone= ZONE

Replace the following:

INSTANCE_NAMES : a whitespace-separated list of names of instances—for example, instance-01 instance-02 instance-03 .
ZONE : the zone where the suspended instances are located.

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // resumeInstance resumes a suspended Google Compute Engine instance 
 // (with unencrypted disks). 
 func 
  
 resumeInstance 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 zone 
 , 
  
 instanceName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // zone := "europe-central2-b" 
  
 // instanceName := "your_instance_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 instancesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewInstancesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewInstancesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 instancesClient 
 . 
 Close 
 () 
  
 getInstanceReq 
  
 := 
  
& computepb 
 . 
 GetInstanceRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Zone 
 : 
  
 zone 
 , 
  
 Instance 
 : 
  
 instanceName 
 , 
  
 } 
  
 instance 
 , 
  
 err 
  
 := 
  
 instancesClient 
 . 
 Get 
 ( 
 ctx 
 , 
  
 getInstanceReq 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get instance: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 instance 
 . 
 GetStatus 
 () 
  
 != 
  
 "SUSPENDED" 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
  
 "only suspended instances can be resumed, instance %s is in %s state" 
 , 
  
 instanceName 
 , 
  
 instance 
 . 
 GetStatus 
 (), 
  
 ) 
  
 } 
  
 resumeInstanceReq 
  
 := 
  
& computepb 
 . 
 ResumeInstanceRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Zone 
 : 
  
 zone 
 , 
  
 Instance 
 : 
  
 instanceName 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 instancesClient 
 . 
  Resume 
 
 ( 
 ctx 
 , 
  
 resumeInstanceReq 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to resume instance: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Instance resumed\n" 
 ) 
  
 return 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Instance 
. Status 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InstancesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Operation 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 ResumeInstance 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // project: project ID or project number of the Cloud project your instance belongs to. 
  
 // zone: name of the zone your instance belongs to. 
  
 // instanceName: name of the instance your want to resume. 
  
 String 
  
 project 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 zone 
  
 = 
  
 "zone-name" 
 ; 
  
 String 
  
 instanceName 
  
 = 
  
 "instance-name" 
 ; 
  
 resumeInstance 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ); 
  
 } 
  
 // Resume a suspended Google Compute Engine instance (with unencrypted disks). 
  
 // Instance state changes to RUNNING, if successfully resumed. 
  
 public 
  
 static 
  
 void 
  
 resumeInstance 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 zone 
 , 
  
 String 
  
 instanceName 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // Instantiates a client. 
  
 try 
  
 ( 
  InstancesClient 
 
  
 instancesClient 
  
 = 
  
  InstancesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 String 
  
 currentInstanceState 
  
 = 
  
 instancesClient 
 . 
 get 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ). 
 getStatus 
 (); 
  
 // Check if the instance is currently suspended. 
  
 if 
  
 ( 
 ! 
 currentInstanceState 
 . 
 equalsIgnoreCase 
 ( 
  Status 
 
 . 
 SUSPENDED 
 . 
 toString 
 ())) 
  
 { 
  
 throw 
  
 new 
  
 RuntimeException 
 ( 
  
 String 
 . 
 format 
 ( 
 "Only suspended instances can be resumed. Instance %s is in %s state." 
 , 
  
 instanceName 
 , 
  
 currentInstanceState 
 )); 
  
 } 
  
  Operation 
 
  
 operation 
  
 = 
  
 instancesClient 
 . 
  resumeAsync 
 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ) 
  
 . 
 get 
 ( 
 300 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 if 
  
 ( 
 operation 
 . 
  hasError 
 
 () 
  
 || 
  
 ! 
 instancesClient 
 . 
 get 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ). 
 getStatus 
 () 
  
 . 
 equalsIgnoreCase 
 ( 
  
  Status 
 
 . 
 RUNNING 
 . 
 toString 
 ())) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Cannot resume instance. Try again!" 
 ); 
  
 return 
 ; 
  
 } 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Instance resumed successfully ! %s" 
 , 
  
 instanceName 
 ); 
  
 } 
  
 } 
 }

Node.js

  /** 
 * 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 
  
 compute 
  
 = 
  
 require 
 ( 
 ' @google-cloud/compute 
' 
 ); 
 // Resumes a suspended Google Compute Engine instance (with unencrypted disks). 
 async 
  
 function 
  
 resumeInstance 
 () 
  
 { 
  
 const 
  
 instancesClient 
  
 = 
  
 new 
  
 compute 
 . 
  InstancesClient 
 
 (); 
  
 const 
  
 [ 
 instance 
 ] 
  
 = 
  
 await 
  
 instancesClient 
 . 
 get 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 , 
  
 instance 
 : 
  
 instanceName 
 , 
  
 }); 
  
 if 
  
 ( 
 instance 
 . 
 status 
  
 !== 
  
 'SUSPENDED' 
 ) 
  
 { 
  
 throw 
  
 new 
  
 Error 
 ( 
  
 'Only suspended instances can be resumed.' 
  
 + 
  
 `Instance 
 ${ 
 instanceName 
 } 
 is in 
 ${ 
 instance 
 . 
 status 
 } 
 state.` 
  
 ); 
  
 } 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 instancesClient 
 . 
 resume 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 , 
  
 instance 
 : 
  
 instanceName 
 , 
  
 }); 
  
 let 
  
 operation 
  
 = 
  
 response 
 . 
 latestResponse 
 ; 
  
 const 
  
 operationsClient 
  
 = 
  
 new 
  
 compute 
 . 
  ZoneOperationsClient 
 
 (); 
  
 // Wait for the create operation to complete. 
  
 while 
  
 ( 
 operation 
 . 
 status 
  
 !== 
  
 'DONE' 
 ) 
  
 { 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 operationsClient 
 . 
 wait 
 ({ 
  
 operation 
 : 
  
 operation 
 . 
 name 
 , 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 : 
  
 operation 
 . 
 zone 
 . 
 split 
 ( 
 '/' 
 ). 
 pop 
 (), 
  
 }); 
  
 } 
  
 console 
 . 
 log 
 ( 
 'Instance resumed.' 
 ); 
 } 
 resumeInstance 
 ();

PHP

  use Google\Cloud\Compute\V1\Client\InstancesClient; 
 use Google\Cloud\Compute\V1\ResumeInstanceRequest; 
 /** 
 * Resume a suspended Google Compute Engine instance (with unencrypted disks). 
 * 
 * @param string $projectId Project ID or project number of the Cloud project your instance belongs to. 
 * @param string $zone Name of the zone your instance belongs to. 
 * @param string $instanceName Name of the instance you want to resume. 
 * 
 * @throws \Google\ApiCore\ApiException if the remote call fails. 
 * @throws \Google\ApiCore\ValidationException if local error occurs before remote call. 
 */ 
 function resume_instance( 
 string $projectId, 
 string $zone, 
 string $instanceName 
 ) { 
 // Resume the suspended Compute Engine instance using InstancesClient. 
 $instancesClient = new InstancesClient(); 
 $request = (new ResumeInstanceRequest()) 
 ->setInstance($instanceName) 
 ->setProject($projectId) 
 ->setZone($zone); 
 $operation = $instancesClient->resume($request); 
 // Wait for the operation to complete. 
 $operation->pollUntilComplete(); 
 if ($operation->operationSucceeded()) { 
 printf('Instance %s resumed successfully' . PHP_EOL, $instanceName); 
 } else { 
 $error = $operation->getError(); 
 printf('Failed to resume instance: %s' . PHP_EOL, $error?->getMessage()); 
 } 
 }

Python

  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 
  
 resume_instance 
 ( 
 project_id 
 : 
 str 
 , 
 zone 
 : 
 str 
 , 
 instance_name 
 : 
 str 
 ) 
 - 
> None 
 : 
  
 """ 
 Resume a suspended Google Compute Engine instance (with unencrypted disks). 
 Args: 
 project_id: project ID or project number of the Cloud project your instance belongs to. 
 zone: name of the zone your instance belongs to. 
 instance_name: name of the instance you want to resume. 
 """ 
 instance_client 
 = 
  compute_v1 
 
 . 
  InstancesClient 
 
 () 
 instance 
 = 
 instance_client 
 . 
  get 
 
 ( 
 project 
 = 
 project_id 
 , 
 zone 
 = 
 zone 
 , 
 instance 
 = 
 instance_name 
 ) 
 if 
 instance 
 . 
 status 
 != 
  compute_v1 
 
 . 
  Instance 
 
 . 
 Status 
 . 
 SUSPENDED 
 . 
 name 
 : 
 raise 
 RuntimeError 
 ( 
 f 
 "Only suspended instances can be resumed. " 
 f 
 "Instance 
 { 
 instance_name 
 } 
 is in 
 { 
 instance 
 . 
 status 
 } 
 state." 
 ) 
 operation 
 = 
 instance_client 
 . 
  resume 
 
 ( 
 project 
 = 
 project_id 
 , 
 zone 
 = 
 zone 
 , 
 instance 
 = 
 instance_name 
 ) 
 wait_for_extended_operation 
 ( 
 operation 
 , 
 "instance resumption" 
 )

REST

To resume a suspended instance, make a POST request to the instances.resume method :

 POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/zones/ ZONE 
/instances/ INSTANCE_NAME 
/resume

Replace the following:

INSTANCE_NAME : the name of the suspend instance to resume.
PROJECT_ID : the ID of the project where the suspended instance is located.
ZONE : the zone where the suspended instance is located.

Suspend or resume a Compute Engine instance Stay organized with collections Save and categorize content based on your preferences.

Before you begin

Console

gcloud

Go

Java

Node.js

PHP

Python

REST

Required roles

Required permissions

Limitations

Enable suspend operations in Debian 8 or 9

Configure the ACPID

Install D-Bus

Suspend an instance

Suspend an instance without Local SSD disks

Console

gcloud

Go

Java

Node.js

PHP

Python

REST

Suspend an instance with Local SSD disks

Console

gcloud

REST

Resume a suspended instance

Console

gcloud

Go

Java

Node.js

PHP

Python

REST

What's next

Suspend or resume a Compute Engine instance