---
title: "Get the list of Notebooks in the given Namespace"
method: GET
path: "/aide/v1/namespaces/{namespace}/notebooks"
---

# Get the list of Notebooks in the given Namespace

`GET /aide/v1/namespaces/{namespace}/notebooks`

Get Notebooks.

## Path parameters

- `namespace` string, string, required

## Query parameters

- `clusterName` string, string
- `page` string, string
- `size` string, string

## Response `200`

OK

- GetNotebooksResponse
  - `notebooks` Notebook[], required
    - `id` string
    - `name` string — Notebook name
    - `user` string — Notebook Owner
    - `namespace` string — Namesapce where notebook has been created
    - `proxyUser` string — Proxy User of Notebook.
    - `cpu` string — CPU used
    - `gpu` string — GPU used
    - `memory` string — Memory used
    - `image` string — Docker Image used
    - `srtImage` string — Image short name
    - `uptime` string — Notebook create time
    - `volumns` string — Notebook volumns mounted
    - `dataVolume` MountInfo[] — Notebook data volumns mounted
      - `mountType` 'New' | 'Existing' | 'None', required — Mount type
      - `localPath` string, required — Local Path or Kubernetes PV/PVC
      - `subPath` string — subPath of localpath
      - `size` integer, required — Storage capacity
      - `mountPath` string, required — Container path
      - `accessMode` 'ReadWriteOnce' | 'ReadWriteMany' | 'ReadOnlyMany' — Data access mode
    - `workspaceVolume` MountInfo
      - `mountType` 'New' | 'Existing' | 'None', required — Mount type
      - `localPath` string, required — Local Path or Kubernetes PV/PVC
      - `subPath` string — subPath of localpath
      - `size` integer, required — Storage capacity
      - `mountPath` string, required — Container path
      - `accessMode` 'ReadWriteOnce' | 'ReadWriteMany' | 'ReadOnlyMany' — Data access mode
    - `status` string — Pod status
    - `pods` string — Notebook pods
    - `service` string — Notebook services
    - `queue` string — BDAP Yarn Queue Setting
    - `executorCores` string — User excutor core setting in BDAP Yarn Cluster
    - `executorMemory` string — User excutor memory setting in BDAP Yarn Cluster
    - `executors` string — User excutors setting in BDAP Yarn Cluster
    - `driverMemory` string — User driver memory in BDAP Yarn Cluster
    - `sparkSessionNum` number — The number of spark session
  - `pages` string, string, required — page number
  - `total` string, string, required — page size

## Other responses

- `401` — Unauthorized
- `404` — The Notebook cannot be found

---

[API](https://skmtc.net/webankfintech/apis/jupyter-server.md) · [All operations](https://skmtc.net/webankfintech/apis/jupyter-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/webankfintech/jupyter-server/versions/96d3198b3b53/schema)