Console
    Contact Us Start free

    List VMs in a zone

    Get a list of VMs in a specific zone in a project.

    Explore further

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

    Code sample

    C#

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

      using 
  
  Google.Cloud.Compute.V1 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 using 
  
 System.Threading.Tasks 
 ; 
 public 
  
 class 
  
 ListZoneInstancesAsyncSample 
 { 
  
 public 
  
 async 
  
 Task<IList<Instance> 
>  
 ListZoneInstancesAsync 
 ( 
  
 // TODO(developer): Set your own default values for these parameters or pass different values when calling this method. 
  
 string 
  
 projectId 
  
 = 
  
 "your-project-id" 
 , 
  
  
 string 
  
 zone 
  
 = 
  
 "us-central1-a" 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
  InstancesClient 
 
  
 client 
  
 = 
  
 await 
  
  InstancesClient 
 
 . 
  CreateAsync 
 
 (); 
  
 IList<Instance> 
  
 allInstances 
  
 = 
  
 new 
  
 List<Instance> 
 (); 
  
 // Make the request to list all VM instances in the given zone in the specified project. 
  
 await 
  
 foreach 
 ( 
 var 
  
 instance 
  
 in 
  
 client 
 . 
  ListAsync 
 
 ( 
 projectId 
 , 
  
 zone 
 )) 
  
 { 
  
 // The result is an Instance collection. 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Instance: {instance.Name}" 
 ); 
  
 allInstances 
 . 
 Add 
 ( 
 instance 
 ); 
  
 } 
  
 return 
  
 allInstances 
 ; 
  
 } 
 }

    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/api/iterator" 
 ) 
 // listInstances prints a list of instances created in given project in given zone. 
 func 
  
 listInstances 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 zone 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // zone := "europe-central2-b" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 instancesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewInstancesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewInstancesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 instancesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 ListInstancesRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Zone 
 : 
  
 zone 
 , 
  
 } 
  
 it 
  
 := 
  
 instancesClient 
 . 
 List 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Instances found in zone %s:\n" 
 , 
  
 zone 
 ) 
  
 for 
  
 { 
  
 instance 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
  Done 
 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "- %s %s\n" 
 , 
  
 instance 
 . 
 GetName 
 (), 
  
 instance 
 . 
 GetMachineType 
 ()) 
  
 } 
  
 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 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InstancesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 ListInstance 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample 
  
 String 
  
 project 
  
 = 
  
 "your-project-id" 
 ; 
  
 String 
  
 zone 
  
 = 
  
 "zone-name" 
 ; 
  
 listInstances 
 ( 
 project 
 , 
  
 zone 
 ); 
  
 } 
  
 // List all instances in the given zone in the specified project ID. 
  
 public 
  
 static 
  
 void 
  
 listInstances 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 zone 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // 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 
  
 ( 
  InstancesClient 
 
  
 instancesClient 
  
 = 
  
  InstancesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // Set the project and zone to retrieve instances present in the zone. 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Listing instances from %s in %s:" 
 , 
  
 project 
 , 
  
 zone 
 ); 
  
 for 
  
 ( 
  Instance 
 
  
 zoneInstance 
  
 : 
  
 instancesClient 
 . 
 list 
 ( 
 project 
 , 
  
 zone 
 ). 
 iterateAll 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 zoneInstance 
 . 
 getName 
 ()); 
  
 } 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "####### Listing instances complete #######" 
 ); 
  
 } 
  
 } 
 }

    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 
  
 compute 
  
 = 
  
 require 
 ( 
 ' @google-cloud/compute 
' 
 ); 
 // List all instances in the given zone in the specified project. 
 async 
  
 function 
  
 listInstances 
 () 
  
 { 
  
 const 
  
 instancesClient 
  
 = 
  
 new 
  
 compute 
 . 
  InstancesClient 
 
 (); 
  
 const 
  
 [ 
 instanceList 
 ] 
  
 = 
  
 await 
  
 instancesClient 
 . 
 list 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 , 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Instances found in zone 
 ${ 
 zone 
 } 
 :` 
 ); 
  
 for 
  
 ( 
 const 
  
 instance 
  
 of 
  
 instanceList 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 ` - 
 ${ 
 instance 
 . 
 name 
 } 
 ( 
 ${ 
 instance 
 . 
 machineType 
 } 
 )` 
 ); 
  
 } 
 } 
 listInstances 
 ();

    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\ListInstancesRequest; 
 /** 
 * List all instances for a particular Cloud project and zone. 
 * 
 * @param string $projectId Your Google Cloud project ID. 
 * @param string $zone Zone to list instances for (like "us-central1-a"). 
 * 
 * @throws \Google\ApiCore\ApiException if the remote call fails. 
 */ 
 function list_instances(string $projectId, string $zone) 
 { 
 // List Compute Engine instances using InstancesClient. 
 $instancesClient = new InstancesClient(); 
 $request = (new ListInstancesRequest()) 
 ->setProject($projectId) 
 ->setZone($zone); 
 $instancesList = $instancesClient->list($request); 
 printf('Instances for %s (%s)' . PHP_EOL, $projectId, $zone); 
 foreach ($instancesList as $instance) { 
 printf(' - %s' . PHP_EOL, $instance->getName()); 
 } 
 }

    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 
 from 
  
 collections.abc 
  
 import 
 Iterable 
 from 
  
 google.cloud 
  
 import 
 compute_v1 
 def 
  
 list_instances 
 ( 
 project_id 
 : 
 str 
 , 
 zone 
 : 
 str 
 ) 
 - 
> Iterable 
 [ 
 compute_v1 
 . 
 Instance 
 ]: 
  
 """ 
 List all instances in the given zone in the specified project. 
 Args: 
 project_id: project ID or project number of the Cloud project you want to use. 
 zone: name of the zone you want to use. For example: “us-west3-b” 
 Returns: 
 An iterable collection of Instance objects. 
 """ 
 instance_client 
 = 
 compute_v1 
 . 
 InstancesClient 
 () 
 instance_list 
 = 
 instance_client 
 . 
 list 
 ( 
 project 
 = 
 project_id 
 , 
 zone 
 = 
 zone 
 ) 
 print 
 ( 
 f 
 "Instances found in zone 
 { 
 zone 
 } 
 :" 
 ) 
 for 
 instance 
 in 
 instance_list 
 : 
 print 
 ( 
 f 
 " - 
 { 
 instance 
 . 
 name 
 } 
 ( 
 { 
 instance 
 . 
 machine_type 
 } 
 )" 
 ) 
 return 
 instance_list

    Ruby

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

      require 
  
 "google/cloud/compute/v1" 
 # Lists all instances in the given zone in the specified project. 
 # 
 # @param [String] project project ID or project number of the Cloud project you want to use. 
 # @param [String] zone name of the zone you want to use. For example: "us-west3-b" 
 # @return [Array<::Google::Cloud::Compute::V1::Instance>] Array of instances. 
 def 
  
 list_instances 
  
 project 
 :, 
  
 zone 
 : 
  
 # Initialize client that will be used to send requests. This client only needs to be created 
  
 # once, and can be reused for multiple requests. 
  
 client 
  
 = 
  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Compute 
 :: 
 V1 
 :: 
 Instances 
 :: 
 Rest 
 :: 
 Client 
 . 
 new 
  
 # Send the request to list all VM instances in the given zone in the specified project. 
  
 instance_list 
  
 = 
  
 client 
 . 
 list 
  
 project 
 : 
  
 project 
 , 
  
 zone 
 : 
  
 zone 
  
 puts 
  
 "Instances found in zone 
 #{ 
 zone 
 } 
 :" 
  
 instances 
  
 = 
  
 [] 
  
 instance_list 
 . 
 each 
  
 do 
  
 | 
 instance 
 | 
  
 puts 
  
 " - 
 #{ 
 instance 
 . 
 name 
 } 
 ( 
 #{ 
 instance 
 . 
 machine_type 
 } 
 )" 
  
 instances 
 << 
 instance 
  
 end 
  
 instances 
 end

    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: