文档首页/ AI科学计算服务/ API参考/ API/ notebook开发环境/ notebook开发环境/ 获取notebook列表
更新时间：2025-09-25 GMT+08:00
查看PDF
分享

获取notebook列表

功能介绍

获取notebook列表。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

参数解释：

空间ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字、中划线和下划线组成，且长度为[1-128]的字符。

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID，您可以从获取项目ID中获取。

约束限制：

不涉及

取值范围：

只能由英文字母、数字、中划线和下划线组成，且长度为[1-128]的字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

限制量，单次查询总量。

约束限制：

不涉及

取值范围：

整数，范围1-1000。

默认取值：

100

name

否

String

参数解释：

notebook名称。

约束限制：

不涉及

取值范围：

长度为[1-200]的字符。

默认取值：

不涉及

offset

否

Integer

参数解释：

偏移量，查询起始偏移。

约束限制：

不涉及

取值范围：

整数，范围0-100000000。

默认取值：

0

status

否

String

参数解释：

notebook状态。

约束限制：

不涉及

取值范围：

  • RUNNING：运行中

  • ABNORMAL：异常

  • HIBERNATE：停止

  • SUCCEEDED：成功

  • CREATING：创建中

  • DELETING：删除中

  • UPDATING：更新中

  • CREATEDFAILED：创建失败

  • DELETEDFAILED：删除失败

  • UPDATEDFAILED：更新失败

  • UNKNOWN：未知

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制：

不涉及

取值范围：

长度为[1-32768]的字符。

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

notebook总数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

notebooks

Array of NotebookEntity objects

参数解释：

notebook详情列表。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 NotebookEntity

参数

参数类型

描述

id

String

参数解释：

notebook ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

notebook名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

eihealth_project_id

String

参数解释：

空间ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

eihealth_project_name

String

参数解释：

空间名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

String

参数解释：

notebook描述。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

creator

String

参数解释：

notebook所属用户。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

url

String

参数解释：

notebook访问URL。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

flavor

FlavorInfo object

参数解释：

notebook规格。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

status

String

参数解释：

notebook状态。

约束限制：

不涉及

取值范围：

  • RUNNING：运行中

  • ABNORMAL：异常

  • HIBERNATE：停止

  • SUCCEEDED：成功

  • CREATING：创建中

  • DELETING：删除中

  • UPDATING：更新中

  • CREATEDFAILED：创建失败

  • DELETEDFAILED：删除失败

  • UPDATEDFAILED：更新失败

  • UNKNOWN：未知

默认取值：

不涉及

image

NotebookImage object

参数解释：

notebook镜像信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

storages

Array of NotebookStorage objects

参数解释：

notebook存储信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

String

参数解释：

notebook创建时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_time

String

参数解释：

notebook更新时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

failed_message

String

参数解释：

notebook失败信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

events

Array of TaskEventRsp objects

参数解释：

cce事件。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表6 FlavorInfo

参数

参数类型

描述

cpu_type

String

参数解释：

cpu架构类型。

约束限制：

不涉及

取值范围：

  • X86: X86架构

  • ARM：ARM架构

默认取值：

X86

cpu

Float

参数解释：

notebook占用的cpu， 0.1核为100m，单位为“C”。

约束限制：

不涉及

取值范围：

1-128之间的浮点数。

默认取值：

1

gpu

Float

参数解释：

notebook占用的gpu，0.1为使用单卡10%，1为占满单个显卡，1+为使用多个显卡。

约束限制：

不涉及

取值范围：

0-16之间的浮点数。

默认取值：

0

gpu_type

String

参数解释：

gpu架构类型。

约束限制：

不涉及

取值范围：

  • GPU：支持GPU

  • Snt9：支持Snt9

默认取值：

不涉及

memory

Float

参数解释：

notebook占用的内存，单位为“G”。

约束限制：

不涉及

取值范围：

范围[2-512]。

默认取值：

2
表7 NotebookImage

参数

参数类型

描述

image_type

String

参数解释：

镜像类型。

约束限制：

不涉及

取值范围：

  • SYSTEM：系统预置

  • CUSTOMER：自定义

默认取值：

不涉及

image_info

ImageInfo object

参数解释：

镜像信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表8 ImageInfo

参数

参数类型

描述

source_project_name

String

参数解释：

源空间名。

约束限制：

不涉及

取值范围：

长度为[1-128]的字符。

默认取值：

不涉及

image_name

String

参数解释：

镜像名。

约束限制：

不涉及

取值范围：

长度为[1-128]的字符，支持小写字母、数字、中划线(-)、下划线(_)、点(.)和斜杠(/)。

默认取值：

不涉及

image_tag

String

参数解释：

镜像tag名。

约束限制：

不涉及

取值范围：

长度为[1-64]的字符，支持大小写字母、数字、中划线(-)、下划线(_)、点(.)和斜杠(/)。

默认取值：

不涉及

profile

String

参数解释：

系统镜像名。

约束限制：

不涉及

取值范围：

仅支持PY3

默认取值：

不涉及
表9 NotebookStorage

参数

参数类型

描述

path

String

参数解释：

notebook存储路径。

约束限制：

不涉及

取值范围：

长度为[1-4096]的字符。

默认取值：

不涉及

mount_path

String

参数解释：

挂载路径，由于目前暂不支持自定义挂载，暂不开放。

约束限制：

不涉及

取值范围：

长度为[1-4096]的字符。

默认取值：

不涉及
表10 TaskEventRsp

参数

参数类型

描述

type

String

参数解释：

任务启动事件类型。

约束限制：

不涉及

取值范围：

  • Normal：表示正常事件

  • Warning：表示警告事件

  • Error：表示错误事件

  • Unknown：表示未知类型的事件

默认取值：

不涉及

count

Integer

参数解释：

任务启动事件发生次数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

reason

String

参数解释：

任务启动事件状态。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

message

String

参数解释：

任务启动事件详细信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

first_timestamp

String

参数解释：

任务启动事件首次上报时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

last_timestamp

String

参数解释：

任务启动事件末次上报时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

获取notebook列表。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks

响应示例

状态码：200

OK

{
  "count" : 1,
  "notebooks" : [ {
    "id" : "DE-7d558ef8-c73d-11ea-964c-0255ac100033",
    "name" : "notebook-example",
    "description" : "notebook description in here",
    "creator" : "notebook_creator",
    "url" : "https://x.x.x.x:0000/0951eb641.../notebook/e4a3b97a.../services/notebook",
    "flavor" : {
      "cpu" : "1",
      "gpu" : "0",
      "gpu_type" : "GPU",
      "memory" : "100"
    },
    "status" : "Running",
    "image" : {
      "image_type" : "SYSTEM",
      "image_info" : {
        "source_project_name" : "eihealth-project",
        "image_name" : "eihealth-notebook",
        "image_tag" : "3.1.0-latest",
        "profile" : "PY3"
      }
    },
    "storages" : [ {
      "path" : "project_name:/example"
    } ],
    "create_time" : "2020-09-10T10:07:17Z",
    "update_time" : "2020-09-10T10:07:17Z",
    "failed_message" : "failed massage in here"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： notebook开发环境

相关文档