Method: projects.locations.notebookRuntimes.list

Lists NotebookRuntimes in a Location.

HTTP request

GET http://{service-endpoint}/v1/{parent}/notebookRuntimes

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
filter

string

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's resource name.
  • displayName supports = and != and regex.
  • notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource 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].

Some examples:

  • notebookRuntime="notebookRuntime123"
  • displayName="myDisplayName" and displayName=~"myDisplayNameRegex"
  • notebookRuntimeTemplate="notebookRuntimeTemplate321"
  • healthState=HEALTHY
  • runtimeState=RUNNING
  • runtimeUser="[email protected]"
  • uiState=UI_RESOURCE_STATE_BEING_DELETED
  • notebookRuntimeType=USER_DEFINED
pageSize

integer

Optional. The standard list page size.
pageToken

string

Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
readMask

string (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".
orderBy

string

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 for NotebookService.ListNotebookRuntimes.

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

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

object (NotebookRuntime)

List of NotebookRuntimes in the requested page.
nextPageToken

string

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.notebookRuntimes.list

For more information, see the IAM documentation.