Method: projects.instances.databases.sessions.list

Lists all sessions in a given database.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
database

string

Required. The database in which to list sessions.

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

  • spanner.sessions.list

Query parameters

Parameters
pageSize

integer

Number of sessions 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 ListSessionsResponse.
filter

string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • labels.key where key is the name of a label

Some examples of using filters are:

  • labels.env:* --> The session has the label "env".
  • labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

Request body

The request body must be empty.

Response body

The response for sessions.list.

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

JSON representation 
{
  "sessions": [
    {
      object (Session)
    }
  ],
  "nextPageToken": string
}
Fields
sessions[]

object (Session)

The list of requested sessions.
nextPageToken

string

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.