Method: projects.instances.list

Lists information about instances in a project.

HTTP request

GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

Authorization requires the following IAM permission on the specified resource parent:

  • bigtable.instances.list

Query parameters

Parameters
pageToken

string

DEPRECATED: This field is unused and ignored.

Request body

The request body must be empty.

Response body

Response message for BigtableInstanceAdmin.ListInstances.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "failedLocations": [
    string
  ],
  "nextPageToken": string
}
Fields
instances[]

object (Instance)

The list of requested instances.
failedLocations[]

string

Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from instances, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zoneId>
nextPageToken

string

DEPRECATED: This field is unused and ignored.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.cluster
  • https://www.googleapis.com/auth/bigtable.admin.instance
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.