Querying Notebook Instances

Function

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

Constraints

None

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

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 and Name.

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. The default value is 10.

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.

pool_id

No

String

ID of a dedicated resource pool

offset

No

Integer

Start offset of the records on each page. The default value is 0.

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 mode. The options are ASC (ascending order) and DESC (descending order). The default value is DESC.

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: The image of the instance is being saved.

  • CREATE_FAILED: Creating the instance failed.

  • START_FAILED: Starting the instance failed.

  • DELETE_FAILED: Deleting the instance failed.

  • ERROR: An error occurred.

  • DELETED: The instance has been deleted.

  • FROZEN: The instance is frozen.

workspaceId

No

String

Workspace ID. If no workspaces are available, the default value is 0.

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

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: The image of the instance is being saved.

  • CREATE_FAILED: Creating the instance failed.

  • START_FAILED: Starting the instance failed.

  • DELETE_FAILED: Deleting the instance failed.

  • ERROR: An error occurred.

  • DELETED: The instance has been 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 workspaces are available, the default value is 0.

feature

String

Instance type. Options:

  • DEFAULT: free CodeLab instance. You can create only one.

  • NOTEBOOK: billed instance.

Table 5 JobProgress

Parameter

Type

Description

notebook_id

String

Instance ID.

status

String

Job status in a specified step. Options:

  • WAITING: The job is awaiting.

  • PROCESSING: The job is being processed.

  • FAILED: The job failed.

  • COMPLETED: The job is complete.

step

Integer

Job step. Options:

  • 1: Prepare storage.

  • 2: Prepare compute resources.

  • 3: Configure the network.

  • 4: Initialize the instance.

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 service. Options:

  • NOTEBOOK: You can access notebook instances 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

arch

String

Processor architecture supported by the image. Options:

  • X86_64: x86 architecture

  • AARCH64: Arm architecture

create_at

Long

Specifies the time (UTC ms) when the image is created.

description

String

Image description with a maximum of 512 characters

dev_services

Array of strings

Services supported by the image. Options:

  • NOTEBOOK: You can access the notebook instance using HTTPS.

  • SSH: You can remotely access the notebook instance from a local IDE through SSH.

id

String

ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format.For details, see Querying Supported Images.

name

String

Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.)

namespace

String

Organization to which the image belongs. You can create and view the organization on the Organization Management page of the SWR console.

origin

String

Image source, which defaults to CUSTOMIZE. Options:

  • CUSTOMIZE: user-defined image

  • IMAGE_SAVE: image saved using a development environment instance

resource_categories

Array of strings

Flavors supported by the image. Options:

  • CPU

  • GPU

service_type

String

Supported image types. Options:

  • COMMON: common image

  • INFERENCE: image used for inference

  • TRAIN: image used for training

  • DEV: image used for development and debugging

  • UNKNOWN: image whose supported services are not specified

size

Long

Image size, in unit of KB

status

String

Image status. Options:

  • INIT: The image is being initialized.

  • CREATING: The image is being saved. In this case, the notebook instance is unavailable.

  • CREATE_FAILED: Saving the image failed.

  • ERROR: An error occurs.

  • DELETED: The image has been deleted.

  • ACTIVE: The image has been saved, which you can view on the SWR console and use to create notebook instances.

status_message

String

Build information during image saving

support_res_categories

Array of strings

Flavors supported by the image. Options:

  • CPU

  • GPU

swr_path

String

SWR image address

tag

String

Image tag

type

String

Image type. Options:

  • BUILD_IN: built-in system image

  • DEDICATED: private image

update_at

Long

Specifies the time (UTC ms) when the image was last updated.

visibility

String

Image visibility. Options:

  • PRIVATE: private image

  • PUBLIC: All users can perform read-only operations based on the image ID.

workspace_id

String

Workspace ID. If no workspaces are available, the default value is 0.

Table 8 Lease

Parameter

Type

Description

create_at

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.

type

String

Indicates the automatic stop type.

update_at

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 4096 GB.

category

String

Supported storage types. For details about the differences between the storage types, see "Selecting Storage in DevEnviron" in User Guide. Options:

  • EFS: Scalable File Service, which is the default storage

  • 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 service.

  • DEDICATED: Resources are managed by 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

OK

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

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

last updated: 2024-11-28 19:02 UTC - commit: 7e602c6c50500da4fb13dea67589040fd3f7deb8