Method: projects.instances.get

Gets information about a particular instance.

HTTP request

GET https://spanner.googleapis.com/v1/{name=projects/*/instances/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The 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:

  • spanner.instances.get

Query parameters

Parameters
fieldMask

string (FieldMask format)

If fieldMask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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/spanner.admin
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.