Querying Notebook Instances

Function

This API is used to query notebook instances based on specified search criteria.

Constraints

None

URI

GET /v1/{project_id}/notebooks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
feature	No	String	Instance type. The default value is NOTEBOOK. Options: DEFAULT: free CodeLab instance. You can create only one. NOTEBOOK: billed instance.
limit	No	Integer	Number of records on each page.
name	No	String	Instance name, which contains a maximum of 128 characters and can consist of uppercase and lowercase letters, digits, hyphens (-), and underscores (_). Fuzzy match is supported.
offset	No	Integer	Start offset of the records on each page.
owner	No	String	User ID of the instance, which contains 32 characters, including lowercase letters and digits. This parameter is valid only when the account is a big account or has the admin permission. Generally, the value is the ID of the current login user.
sort_dir	No	String	Sorting order. The options are ASC (ascending order) and DESC (descending order).
sort_key	No	String	Sorting fields. Separate multiple fields with commas (,).
status	No	String	Instance status. Options: INIT: The instance is being initialized. CREATING: The instance is being created. STARTING: The instance is starting. STOPPING: The instance is stopping. DELETING: The instance is being deleted. RUNNING: The instance is running. STOPPED: The instance is stopped. SNAPSHOTTING: A snapshot is being taken for the instance (status when the image is being saved). CREATE_FAILED: The instance fails to be created. START_FAILED: The instance fails to be started. DELETE_FAILED: The instance fails to be deleted. ERROR: An error occurs. DELETED: The instance is deleted. FROZEN: The instance is frozen.
workspaceId	No	String	Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
current	Integer	Current page
data	Array of NotebookResp objects	Data
pages	Integer	Total pages
size	Integer	Number of records on each page
total	Long	Total records

**Table 4** NotebookResp
Parameter	Type	Description
action_progress	Array of JobProgress objects	Instance initialization progress.
description	String	Instance description
endpoints	Array of EndpointsRes objects	Local IDE (such as PyCharm and vsCode) or SSH client for remotely accessing a notebook instance through SSH.
fail_reason	String	Instance failure cause
feature	String	Instance type. Options: DEFAULT: free CodeLab instance. You can create only one. NOTEBOOK: billed instance.
flavor	String	Instance flavor
id	String	Instance ID.
image	Image object	Instance image
lease	Lease object	Countdown to automatic instance stop.
name	String	Instance name
pool	Pool object	Basic information about the dedicated pool, which is returned by the instance created in the dedicated pool.
status	String	Instance status Options: INIT: The instance is being initialized. CREATING: The instance is being created. STARTING: The instance is starting. STOPPING: The instance is stopping. DELETING: The instance is being deleted. RUNNING: The instance is running. STOPPED: The instance is stopped. SNAPSHOTTING: A snapshot is being taken for the instance (status when the image is being saved). CREATE_FAILED: The instance fails to be created. START_FAILED: The instance fails to be started. DELETE_FAILED: The instance fails to be deleted. ERROR: An error occurs. DELETED: The instance is deleted. FROZEN: The instance is frozen.
token	String	Token used for notebook authentication
url	String	URL for accessing the notebook instance
volume	VolumeRes object	Storage volume
workspace_id	String	Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

**Table 5** JobProgress
Parameter	Type	Description
notebook_id	String	Instance ID.
status	String	Job status in a specified step. Options: WAITING: The job is waiting to begin. PROCESSING: The job is being processed. FAILED: The job failed. COMPLETED: The task is complete.
step	Integer	Job step. Options: 1: Storage preparation. 2: Computing resource preparation. 3: Network configurations. 4: Instance initialization.
step_description	String	Description of a step in a job.

**Table 6** EndpointsRes
Parameter	Type	Description
allowed_access_ips	Array of strings	Whitelist of public IP addresses that are allowed to access the notebook instance through SSH. By default, all public IP addresses can access the notebook instance. If this parameter is specified, only the clients with the specified IP addresses can access the notebook instance.
dev_service	String	Supported services. Options: NOTEBOOK: You can access the notebook instance using HTTPS. SSH: You can remotely access the notebook instance through SSH.
ssh_keys	Array of strings	List of SSH key pairs. You can set multiple key pairs to access an SSH instance at the same time.

**Table 7** Image
Parameter	Type	Description
id	String	Image ID
name	String	Image name.
swr_path	String	SWR image address
type	String	Image type. Options: BUILD_IN: built-in system image DEDICATED: image saved by the user

**Table 8** Lease
Parameter	Type	Description
create_time	Long	Time (UTC) when the instance is created, accurate to millisecond.
duration	Long	Instance running duration, which is calculated based on the instance creation time. If the instance creation time plus the duration is greater than the current time, the system automatically stops the instance.
enable	Boolean	Whether to enable auto stop of the instance.
update_time	Long	Time (UTC) when the instance is last updated (excluding the keepalive heartbeat time), accurate to millisecond.

**Table 9** Pool
Parameter	Type	Description
id	String	ID of a dedicated resource pool
name	String	Name of a dedicated resource pool

**Table 10** VolumeRes
Parameter	Type	Description
capacity	Integer	Storage capacity. The default value is 5 GB for EVS and 50 GB for EFS. The maximum value is 4,096 GB.
category	String	Storage category. Options: EFS: Scalable File Service (SFS), which is the default storage. EVS: Elastic Volume Service (EVS).
mount_path	String	Directory of the notebook instance to which OBS storage is mounted. Currently, the directory is /home/ma-user/work/.
ownership	String	Owner to which the resource belongs. Options: MANAGED: Resources are managed by services. DEDICATED: Resources are managed by the user account. This mode is supported only when the instance category is EFS.
status	String	EVS disk capacity expansion status, which is RESIZING during capacity expansion and does not affect the instance.

Example Requests

None

Example Responses

Status code: 200

{
  "current" : 0,
  "data" : [ {
    "create_at" : 1638841805440,
    "data_volumes" : [ ],
    "endpoints" : [ {
      "service" : "NOTEBOOK",
      "uri" : "https://authoring-modelarts-cnnorth7.ulanqab.xxxx.com/f9937afa-ca78-45b6-bc12-7ecf42553c48/lab"
    } ],
    "feature" : "DEFAULT",
    "flavor" : "modelarts.vm.cpu.free",
    "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48",
    "image" : {
      "description" : "description",
      "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
      "name" : "notebook2.0-mul-kernel-cpu-cp36",
      "swr_path" : "swr.xxx.xxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
      "tag" : "3.3.2-release_v1",
      "type" : "BUILD_IN"
    },
    "lease" : {
      "create_at" : 1638841805439,
      "duration" : 3600000,
      "enable" : true,
      "update_at" : 1638841805439
    },
    "name" : "notebook_5ee4bf0e",
    "status" : "RUNNING",
    "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737",
    "update_at" : 1638841838725,
    "url" : "https://authoring-modelarts-cnnorth7.ulanqab.xxxx.com/f9937afa-ca78-45b6-bc12-7ecf42553c48/lab",
    "volume" : {
      "category" : "EFS",
      "ownership" : "MANAGED",
      "mount_path" : "/home/ma-user/work/",
      "capacity" : 50,
      "usage" : -1
    },
    "workspace_id" : "0"
  }, {
    "create_at" : 1638841744521,
    "data_volumes" : [ ],
    "description" : "api-test",
    "endpoints" : [ {
      "service" : "NOTEBOOK",
      "uri" : "https://authoring-modelarts-cnnorth7.ulanqab.xxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab"
    } ],
    "feature" : "NOTEBOOK",
    "flavor" : "modelarts.vm.cpu.2u",
    "id" : "f9937afa-4451-42db-a76b-72d624749f66",
    "image" : {
      "description" : "description",
      "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
      "name" : "notebook2.0-mul-kernel-cpu-cp36",
      "swr_path" : "swr.xxx.xxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
      "tag" : "3.3.2-release_v1",
      "type" : "BUILD_IN"
    },
    "lease" : {
      "create_at" : 1638841744515,
      "duration" : 3600000,
      "enable" : true,
      "update_at" : 1638841744515
    },
    "name" : "notebooks_test",
    "status" : "RUNNING",
    "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
    "update_at" : 1638841776582,
    "url" : "https://authoring-modelarts-cnnorth7.ulanqab.xxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab",
    "volume" : {
      "category" : "EFS",
      "ownership" : "MANAGED",
      "mount_path" : "/home/ma-user/work/",
      "capacity" : 50,
      "usage" : -1
    },
    "workspace_id" : "0"
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 2
}