Method: projects.locations.sessions.list

Lists sessions in the specified project and location.

HTTP request

GET https://managedflink.googleapis.com/v1alpha/{parent=projects/*/locations/*}/sessions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent value for ListSessionsRequest. The value is the location, specified in the following format: projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

pageToken

string

Optional. A token that identifies a page of results that the server should return.

filter

string

Optional. An expression to filter the list of returned sessions. For example, you can filter for active sessions. The expression must use the syntax as documented in AIP-160.

orderBy

string

Optional. A hint for how to order the results. For example, you can order by time of creation or last change. The hint must be specified as documented in AIP-132.

Request body

The request body must be empty.

Response body

Message for response to listing sessions.

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

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

object (Session)

The list of sessions.

nextPageToken

string

The maximum number of sessions to return. The server might return fewer items than requested. If unspecified, at most 50 sessions are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • managedflink.sessions.list

For more information, see the IAM documentation.