gce_list_instances: Retrieves the list of instances contained within the...

View source: R/instances_admin.R

gce_list_instancesR Documentation

Retrieves the list of instances contained within the specified zone.

Description

Retrieves the list of instances contained within the specified zone.

Usage

gce_list_instances(
  filter = NULL,
  maxResults = NULL,
  pageToken = NULL,
  project = gce_get_global_project(),
  zone = gce_get_global_zone()
)

Arguments

filter

Sets a filter expression for filtering listed resources, in the form filter=expression

maxResults

The maximum number of results per page that should be returned

pageToken

Specifies a page token to use

project

Project ID for this request

zone

The name of the zone for this request

Details

Authentication scopes used by this function are:

  • https://www.googleapis.com/auth/cloud-platform

  • https://www.googleapis.com/auth/compute

  • https://www.googleapis.com/auth/compute.readonly

To filter you need a single string in the form field_name eq|ne string e.g. gce_list_instances("status eq RUNNING") where eq is 'equals' and ne is 'not-equals'.

See Also

Google Documentation


cloudyr/googleComputeEngineR documentation built on June 11, 2025, 8:47 a.m.