Method: projects.instances.databases.list

Lists Cloud Spanner databases.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

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

  • spanner.databases.list

Query parameters

Parameters
pageSize

number

Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

pageToken

string

If non-empty, pageToken should contain a nextPageToken from a previous ListDatabasesResponse.

Request body

The request body must be empty.

Response body

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

The response for databases.list.

JSON representation
{
  "databases": [
    {
      object(Database)
    }
  ],
  "nextPageToken": string
}
Fields
databases[]

object(Database)

Databases that matched the request.

nextPageToken

string

nextPageToken can be sent in a subsequent databases.list call to fetch more of the matching databases.

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Spanner Documentation