Method: projects.locations.instances.list

Lists instances in a given project and location.

HTTP request

GET https://notebooks.googleapis.com/v2/{parent}/instances

Path parameters

Parameters
parent

string

Required. Format: parent=projects/{projectId}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • notebooks.instances.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum return size of the list call.
pageToken

string

Optional. A previous returned page token that can be used to continue listing from the last result.
orderBy

string

Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter

string

Optional. List filter.

Request body

The request body must be empty.

Response body

Response for listing notebook instances.

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

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

object (Instance)

A list of returned instances.
nextPageToken

string

Page token that can be used to continue listing from the last result in the next list call.
unreachable[]

string

Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.