Console
    Contact Us Start free

    Resume a suspended VM

    Resume a suspended VM in the specified project and zone.

    Explore further

    For detailed documentation that includes this code sample, see the following:

    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" 
 ) 
 // 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

    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. 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

    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 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

    Before trying this sample, follow the PHP setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine PHP 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 .

      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

    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 
  
 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" 
 )

    What's next

    To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: