- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists all sessions in a given database.
HTTP request
GET https://spanner.googleapis.com/v1/{database=projects/*/instances/*/databases/*}/sessions
The URLs use gRPC Transcoding syntax.
Path 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
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.keywhere 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 (
|
| Fields | |
|---|---|
sessions[]
|
The list of requested sessions. |
nextPageToken
|
|
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 .
