文档首页/ AI开发平台ModelArts/ API参考/ 开发环境管理/ 查询Notebook实例列表

更新时间：2025-07-28 GMT+08:00

查看PDF

查询Notebook实例列表

功能介绍

查询Notebook实例列表接口用于获取满足特定条件的Notebook实例信息。该接口适用于以下场景：用户管理多个Notebook实例或查看特定状态的Notebook实例时，可通过此接口获取相关信息。使用该接口的前提条件是用户已创建Notebook实例，并且具有相应的查询权限。调用成功后，系统将返回符合条件的Notebook实例列表，包含实例ID、状态、创建时间等详细信息。若用户无权限访问或查询条件不明确，接口将返回相应的错误信息或空列表。

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/notebooks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID，获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
feature	否	String	参数解释：实例类别。约束限制：不涉及。取值范围：枚举类型，取值如下： DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。 NOTEBOOK：计费规格实例。默认取值：NOTEBOOK。
limit	否	Integer	参数解释：每一页显示实例的数量。约束限制：不涉及。取值范围：[10,20,50]。默认取值：10。
name	否	String	参数解释：实例名称，支持模糊匹配查询。约束限制：不涉及。取值范围：长度限制128个字符，支持大小写字母、数字、中划线和下划线。默认取值：不涉及。
pool_id	否	String	参数解释：专属资源池ID。约束限制：不涉及。取值范围：长度最长为64个字符，最短为4个字符，支持小写字母、数字、中划线，且必须是小写字母开头，小写字母或数字结尾。默认取值：不涉及。
offset	否	Integer	参数解释：分页记录的起始位置偏移量。约束限制：不涉及。取值范围：不涉及。默认取值：0。
owner	否	String	参数解释：实例归属的用户ID，在大账号/有admin权限场景下生效，值通常为当前登录用户ID。约束限制：不涉及。取值范围：长度为32位小写字母、数字。默认取值：不涉及。
sort_dir	否	String	参数解释：实例排序方式。约束限制：不涉及。取值范围：枚举类型，取值如下： ASC：升序 DESC：降序默认取值：DESC。
sort_key	否	String	参数解释：排序的字段，多个字段使用(“,”)逗号分隔。约束限制：不涉及。取值范围：长度限制为128个字符，支持大小写字母、数字、中划线、下划线和逗号。默认取值：不涉及。
status	否	String	参数解释：实例状态。约束限制：不涉及。取值范围：枚举类型，取值如下： INIT：初始化 CREATING：创建中 STARTING：启动中 STOPPING：停止中 DELETING：删除中 RUNNING：运行中 STOPPED：已停止 SNAPSHOTTING：快照中(保存镜像时的状态) CREATE_FAILED：创建失败 START_FAILED：启动失败 DELETE_FAILED：删除失败 ERROR：错误 DELETED：已删除 FROZEN：冻结默认取值：不涉及。
workspaceId	否	String	参数解释：工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。约束限制：不涉及。取值范围：不涉及。默认取值：0。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：正整数。
data	Array of NotebookResp objects	参数解释：Notebook实例数据。
pages	Integer	参数解释：总的页数。取值范围：正整数。
size	Integer	参数解释：每一页的数量。取值范围：正整数。
total	Long	参数解释：总的记录数量。取值范围：非负整数。

表4 NotebookResp
参数	参数类型	描述
action_progress	Array of JobProgress objects	参数解释：实例初始化进度。
description	String	参数解释：实例描述。取值范围：不涉及。
endpoints	Array of EndpointsRes objects	参数解释：本地IDE（如PyCharm、VS Code）或SSH客户端，通过SSH远程接入Notebook实例时需要的相关配置。
fail_reason	String	参数解释：实例失败原因。取值范围：不涉及。
flavor	String	参数解释：实例规格。取值范围：不涉及。
id	String	参数解释：实例ID。取值范围：不涉及。
image	Image object	参数解释：实例镜像信息。
lease	Lease object	参数解释：实例自动停止的倒计时信息。
name	String	参数解释：实例名称。取值范围：不涉及。
pool	Pool object	参数解释：专属池的基本信息，在专属池中创建的实例会返回该字段。
status	String	参数解释：实例状态。取值范围：枚举类型，取值如下： INIT：初始化 CREATING：创建中 STARTING：启动中 STOPPING：停止中 DELETING：删除中 RUNNING：运行中 STOPPED：已停止 SNAPSHOTTING：快照中(保存镜像时的状态) CREATE_FAILED：创建失败 START_FAILED：启动失败 DELETE_FAILED：删除失败 ERROR：错误 DELETED：已删除 FROZEN：冻结
token	String	参数解释：Notebook鉴权使用的token信息。取值范围：不涉及。
url	String	参数解释：实例访问的URL。取值范围：不涉及。
volume	VolumeRes object	参数解释：实例存储信息。
workspace_id	String	参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。取值范围：不涉及。
feature	String	参数解释：实例类别。取值范围：枚举类型，取值如下： DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。 NOTEBOOK：计费规格实例。
billing_items	Array of strings	参数解释：计费资源类型。枚举类型，取值如下： STORAGE：存储资源计费。 COMPUTE：计算资源计费。 ALL：所有计费类型。
user	user object	参数解释：账号信息。

表5 JobProgress
参数	参数类型	描述
notebook_id	String	参数解释：实例ID。取值范围：不涉及。
status	String	参数解释：任务某个步骤的状态。取值范围：枚举类型，取值如下： WAITING：等待中 PROCESSING：处理中 FAILED：任务失败 COMPLETED：任务完成
step	Integer	参数解释：任务的步骤。取值范围：枚举类型，取值如下： 1：准备存储 2：准备计算资源 3：配置网络 4：初始化实例
step_description	String	参数解释：任务某个步骤的描述。取值范围：不涉及。

表6 EndpointsRes
参数	参数类型	描述
allowed_access_ips	Array of strings	参数解释：允许通过SSH协议访问Notebook的公网IP地址白名单列表，默认都可以访问。当配置指定IP后，则仅允许IP所在的客户端实现对Notebook的访问。
dev_service	String	参数解释：访问Notebook的途径。取值范围：枚举类型，取值如下： NOTEBOOK：可以通过https协议访问Notebook。 SSH：可以通过SSH协议远程连接Notebook。
ssh_keys	Array of strings	参数解释：SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。
service	String	参数解释：访问Notebook的途径。取值范围：枚举类型，取值如下： NOTEBOOK：可以通过https协议访问Notebook。 SSH：可以通过SSH协议远程连接Notebook。
uri	String	参数解释：实例私有IP地址。取值范围：不涉及。

表7 Image
参数	参数类型	描述
arch	String	参数解释：该镜像所支持处理器架构类型。取值范围：枚举类型，取值如下： X86_64：x86处理器架构。 AARCH64：ARM体系架构。
create_at	Long	参数解释：镜像创建的时间，UTC毫秒。取值范围：不涉及。
description	String	参数解释：该镜像所对应的描述信息。取值范围：长度限制512个字符。
dev_services	Array of strings	参数解释：镜像支持的服务。取值范围：枚举类型，取值如下： NOTEBOOK：镜像支持通过https协议访问Notebook。 SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。
id	String	参数解释：待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。取值范围：不涉及。
name	String	参数解释：镜像名称。取值范围：长度限制512个字符，支持小写字母、数字、中划线、下划线和点。
namespace	String	参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。取值范围：不涉及。
origin	String	参数解释：指定镜像来源。取值范围：枚举类型，取值如下： CUSTOMIZE：用户自定义构建镜像。 IMAGE_SAVE：Notebook实例保存镜像。
resource_categories	Array of strings	参数解释：镜像支持的规格。枚举类型，取值如下： CPU GPU ASCEND
service_type	String	参数解释：镜像支持服务类型。取值范围：枚举类型，取值如下： COMMON：通用镜像。 INFERENCE：建议仅在推理部署场景使用。 TRAIN：建议仅在训练任务场景使用。 DEV：建议仅在开发调测场景使用。 UNKNOWN：未明确设置的镜像支持的服务类型。
size	Long	参数解释：镜像大小（单位KB）。取值范围：不涉及。
status	String	参数解释：镜像状态。取值范围：枚举类型，取值如下： INIT：初始化。 CREATING：镜像保存中，此时Notebook不可用。 CREATE_FAILED：镜像保存失败。 ERROR：错误。 DELETED：已删除。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。
status_message	String	参数解释：镜像保存操作过程中，构建信息展示。取值范围：不涉及。
support_res_categories	Array of strings	参数解释：镜像支持的规格。枚举类型，取值如下： CPU GPU ASCEND
swr_path	String	参数解释：SWR镜像地址。取值范围：不涉及。
tag	String	参数解释：镜像Tag。取值范围：不涉及。
type	String	参数解释：镜像类型。取值范围：枚举类型，取值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。
update_at	Long	参数解释：镜像最后更新的时间，UTC毫秒。取值范围：不涉及。
visibility	String	参数解释：镜像可见度。取值范围：枚举类型，取值如下： PRIVATE：私有镜像。 PUBLIC：所有用户可以根据image_id来进行只读使用。
workspace_id	String	参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。取值范围：不涉及。
flavor_type	String	参数解释：镜像的资源类型。取值范围：枚举类型，取值如下： ASCEND_SNT9 ASCEND_SNT9B ASCEND_SNT3

表8 Lease
参数	参数类型	描述
create_at	Long	参数解释：实例创建的时间，UTC毫秒。取值范围：不涉及。
duration	Long	参数解释：实例运行时长，以创建时间为起点计算，即“创建时间+duration > 当前时刻”时，系统会自动停止实例。取值范围：不涉及。
enable	Boolean	参数解释：是否启用自动停止功能。取值范围：布尔类型： true：启动自动停止功能。 false：关闭自动停止功能。
type	String	参数解释：自动停止类别。取值范围：枚举类型，取值如下： TIMING：自动停止。 IDLE：空闲停止。
update_at	Long	参数解释：实例最后更新（不包括探活心跳）的时间，UTC毫秒。取值范围：不涉及。

表9 Pool
参数	参数类型	描述
id	String	参数解释：专属资源池ID。取值范围：不涉及。
name	String	参数解释：专属资源池名称。取值范围：不涉及。

**表10** VolumeRes
参数	参数类型	描述
capacity	Integer	参数解释：存储容量。取值范围：EVS默认5G，EFS默认50G，最大限制4096G。
category	String	参数解释：支持的存储类型。不同存储类型的差异，详见开发环境中如何选择存储。取值范围：枚举类型，取值如下： SFS：弹性文件服务 EVS：云硬盘 OBS：对象存储服务 OBSFS：并行文件系统 EFS：弹性文件服务（SFS Turbo）
mount_path	String	参数解释：存储挂载至Notebook实例的目录，当前固定在/home/ma-user/work/下。取值范围：不涉及。
ownership	String	参数解释：资源所属。取值范围：枚举类型，取值如下： MANAGED：托管，即资源在服务上。 DEDICATED：非托管，即资源在用户账号上，只有在category为EFS时支持。
status	String	参数解释：EVS扩容状态，扩容时的状态为RESIZING，此时实例可以正常使用。取值范围：不涉及。

**表11** user
参数	参数类型	描述
domain	domain object	参数解释：账号domain信息。
id	String	参数解释：IAM用户ID。获取方法请参见获取用户ID和名称。取值范围：不涉及。
name	String	参数解释：IAM用户名。取值范围：不涉及。

**表12** domain
参数	参数类型	描述
id	String	参数解释：账号ID。取值范围：不涉及。
name	String	参数解释：账号名。取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/notebooks

响应示例

状态码：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
}

状态码

状态码	描述
200	OK。
401	Unauthorized。
403	Forbidden。
404	Not Found。

错误码

请参见错误码。

父主题： 开发环境管理

上一篇：创建Notebook实例

下一篇：查询所有Notebook实例列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问