Method: notebookRuntimes.list Stay organized with collections Save and categorize content based on your preferences.
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
parentstringRequired. The resource name of the Location from which to list the NotebookRuntimes. Format:projects/{project}/locations/{location}
Query parameters
filterstringOptional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
notebookRuntimesupports = and !=.notebookRuntimerepresents the NotebookRuntime id, i.e. the last segment of the NotebookRuntime'sresource name.displayNamesupports = and != and regex.notebookRuntimeTemplatesupports = and !=.notebookRuntimeTemplaterepresents the NotebookRuntimeTemplate id, i.e. the last segment of the NotebookRuntimeTemplate'sresource name.healthStatesupports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED].runtimeStatesupports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID].runtimeUsersupports = and !=.- API version is UI only:
uiStatesupports = 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]. notebookRuntimeTypesupports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].machineTypesupports = and !=.acceleratorTypesupports = and !=.
Some examples:
notebookRuntime="notebookRuntime123"displayName="myDisplayName"anddisplayName=~"myDisplayNameRegex"notebookRuntimeTemplate="notebookRuntimeTemplate321"healthState=HEALTHYruntimeState=RUNNINGruntimeUser="test@google.com"uiState=UI_RESOURCE_STATE_BEING_DELETEDnotebookRuntimeType=USER_DEFINEDmachineType=e2-standard-4acceleratorType=NVIDIA_TESLA_T4
pageSizeintegerOptional. The standard list page size.
pageTokenstringOptional. 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".
orderBystringOptional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
displayNamecreateTimeupdateTime
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:
notebookRuntimes[]object (NotebookRuntime)List of NotebookRuntimes in the requested page.
nextPageTokenstringA token to retrieve next page of results. Pass toListNotebookRuntimesRequest.page_token to obtain that page.
| JSON representation |
|---|
{"notebookRuntimes":[{object ( |
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.