Method: projects.instances.get

Gets information about an instance.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

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

  • bigtable.instances.get

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Instance.

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.