AI开发平台MODELARTS-查询Notebook实例列表:URI

时间:2024-10-24 09:20:53

URI

GET /v1/{project_id}/notebooks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID,获取方法请参见获取项目ID和名称

表2 Query参数

参数

是否必选

参数类型

描述

feature

String

实例类别,默认为NOTEBOOK。枚举值如下:

  • DEFAULT:CodeLab免费规格实例,每个用户最多只能创建一个。

  • NOTEBOOK:计费规格实例。

limit

Integer

每一页的数量,默认值10。

name

String

实例名称,支持模糊匹配查询,限制128个字符,支持大小写字母、数字、中划线和下划线。

pool_id

String

专属资源池ID。

offset

Integer

分页记录的起始位置偏移量,默认值0。

owner

String

实例归属的用户ID,长度为32位小写字母、数字,在大账号/有admin权限场景下生效,值通常为当前登录用户ID。

sort_dir

String

排序方式,ASC升序,DESC降序,默认DESC。

sort_key

String

排序的字段,多个字段使用(“,”)逗号分割。

status

String

实例状态。枚举值如下:

  • INIT:初始化

  • CREATING:创建中

  • STARTING:启动中

  • STOPPING:停止中

  • DELETING:删除中

  • RUNNING:运行中

  • STOPPED:已停止

  • SNAPSHOTTING:快照中(保存镜像时的状态)

  • CREATE_FAILED:创建失败

  • START_FAILED:启动失败

  • DELETE_FAILED:删除失败

  • ERROR:错误

  • DELETED:已删除

  • FROZEN:冻结

workspaceId

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。

support.huaweicloud.com/api-modelarts/ListNotebooks.html