Required. The parent, which owns this collection of sessions.
Authorization requires the followingIAMpermission on the specified resourceparent:
dataproc.sessions.list
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
pageToken
string
Optional. A page token received from a previoussessions.listcall. Provide this token to retrieve the subsequent page.
filter
string
Optional. A filter for the sessions to return in the response.
A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields aresession_id,session_uuid,state,create_time, andlabels.
Example:state = ACTIVE and create_time < "2023-01-01T00:00:00Z"is a filter for sessions in an ACTIVE state that were created before 2023-01-01.state = ACTIVE and labels.environment=productionis a filter for sessions in an ACTIVE state that have a production environment label.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-21 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of interactive sessions using a \u003ccode\u003eGET\u003c/code\u003e request to the specified URL, structured according to gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required to identify the collection of sessions, and listing sessions requires the \u003ccode\u003edataproc.sessions.list\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe API supports optional query parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e to control the number of results, pagination, and to refine results based on different criteria.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the successful response includes a JSON representation containing an array of session objects and an optional \u003ccode\u003enextPageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this API call requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, as detailed in the Authentication Overview.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.sessions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSessionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists interactive sessions.\n\n### HTTP request\n\n`GET https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/sessions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of interactive sessions.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
