Method: notebookRuntimes.list

Full name: projects.locations.notebookRuntimes.list

Lists NotebookRuntimes in a Location.

Endpoint

gethttps://{service-endpoint}/v1/{parent}/notebookRuntimes

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

parentstring

Required. The resource name of the Location from which to list the NotebookRuntimes. Format:projects/{project}/locations/{location}

Query parameters

filterstring

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • notebookRuntime supports = and !=.notebookRuntime represents the NotebookRuntime id, i.e. the last segment of the NotebookRuntime'sresource name.
  • displayName supports = and != and regex.
  • notebookRuntimeTemplate supports = and !=.notebookRuntimeTemplate represents the NotebookRuntimeTemplate id, i.e. the last segment of the NotebookRuntimeTemplate'sresource name.
  • healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED].
  • runtimeState supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID].
  • runtimeUser supports = and !=.
  • API version is UI only:uiState supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED].
  • notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].
  • machineType supports = and !=.
  • acceleratorType supports = and !=.

Some examples:

  • notebookRuntime="notebookRuntime123"
  • displayName="myDisplayName" anddisplayName=~"myDisplayNameRegex"
  • notebookRuntimeTemplate="notebookRuntimeTemplate321"
  • healthState=HEALTHY
  • runtimeState=RUNNING
  • runtimeUser="test@google.com"
  • uiState=UI_RESOURCE_STATE_BEING_DELETED
  • notebookRuntimeType=USER_DEFINED
  • machineType=e2-standard-4
  • acceleratorType=NVIDIA_TESLA_T4
pageSizeinteger

Optional. The standard list page size.

pageTokenstring

Optional. The standard list page token. Typically obtained viaListNotebookRuntimesResponse.next_page_token of the previousNotebookService.ListNotebookRuntimes call.

readMaskstring (FieldMask format)

Optional. Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

orderBystring

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • displayName
  • createTime
  • updateTime

Example:displayName, createTime desc.

Request body

The request body must be empty.

Response body

Response message forNotebookService.ListNotebookRuntimes.

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

Fields
notebookRuntimes[]object (NotebookRuntime)

List of NotebookRuntimes in the requested page.

nextPageTokenstring

A token to retrieve next page of results. Pass toListNotebookRuntimesRequest.page_token to obtain that page.

JSON representation
{"notebookRuntimes":[{object (NotebookRuntime)}],"nextPageToken":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.