查询所有Notebook实例列表
功能介绍
查询所有Notebook实例列表,用户可按需查询满足条件的Notebook实例列表。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/notebooks/all
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID,获取方法请参见获取项目ID和名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
feature |
否 |
String |
实例类别,默认为NOTEBOOK。枚举值如下:
|
limit |
否 |
Integer |
每一页的数量,默认值10。 |
name |
否 |
String |
实例名称,支持模糊匹配查询。限制128个字符,支持大小写字母、数字、中划线和下划线。 |
pool_id |
否 |
String |
专属资源池ID,获取方法请参见查询资源池列表。 |
offset |
否 |
Integer |
分页记录的起始位置偏移量,默认值0。 |
owner |
否 |
String |
实例归属的User Id,长度为32位小写字母、数字,在主账号/有admin权限场景下生效,值通常为当前登录用户ID。 |
sort_dir |
否 |
String |
排序方式,ASC升序,DESC降序,默认DESC。 |
sort_key |
否 |
String |
排序的字段,多个字段使用(“,”)逗号分割。 |
status |
否 |
String |
实例状态。枚举值如下:
|
workspaceId |
否 |
String |
工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
current |
Integer |
当前页数。 |
data |
Array of NotebookResp objects |
数据。 |
pages |
Integer |
总的页数。 |
size |
Integer |
每一页的数量。 |
total |
Long |
总的记录数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
实例状态。枚举值如下:
|
token |
String |
Notebook鉴权使用的token信息。 |
url |
String |
实例访问的URL。 |
volume |
VolumeRes object |
实例存储信息。 |
workspace_id |
String |
工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
feature |
String |
实例类别。枚举值:
|
billing_items |
Array of strings |
计费资源类型。枚举值: STORAGE:存储资源计费。 COMPUTE:计算资源计费。 ALL:所有计费类型 |
user |
user object |
账号信息 |
参数 |
参数类型 |
描述 |
---|---|---|
notebook_id |
String |
实例ID。 |
status |
String |
任务某个步骤的状态。枚举值如下:
|
step |
Integer |
任务的步骤。枚举值如下:
|
step_description |
String |
任务某个步骤的描述。 |
参数 |
参数类型 |
描述 |
---|---|---|
allowed_access_ips |
Array of strings |
允许通过SSH协议访问Notebook的公网IP地址白名单列表,默认都可以访问。当配置指定IP后,则仅允许IP所在的客户端实现对Notebook的访问。 |
dev_service |
String |
访问Notebook的途径,枚举值如下:
|
ssh_keys |
Array of strings |
SSH密钥对名称列表,允许设置多个密钥对实现同时对SSH实例的访问。 |
service |
String |
访问Notebook的途径,枚举值如下:
|
uri |
String |
实例私有IP地址。 |
参数 |
参数类型 |
描述 |
---|---|---|
arch |
String |
该镜像所支持处理器架构类型。枚举值如下:
|
create_at |
Long |
镜像创建的时间,UTC毫秒。 |
description |
String |
该镜像所对应的描述信息,长度限制512个字符。 |
dev_services |
Array of strings |
镜像支持的服务。枚举值如下:
|
id |
String |
待创建Notebook实例的镜像,需要指定镜像ID,ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID)。预置镜像的ID参考查询支持的镜像列表获取。 |
name |
String |
镜像名称,长度限制512个字符,支持小写字母、数字、中划线、下划线和点。 |
namespace |
String |
镜像所属组织,可以在SWR控制台“组织管理”创建和查看。 |
origin |
String |
指定镜像来源,可选项,默认自定义构建镜像为CUSTOMIZE。枚举值如下:
|
resource_categories |
Array of strings |
镜像支持的规格。枚举值如下:
|
service_type |
String |
镜像支持服务类型。枚举值如下:
|
size |
Long |
镜像大小(单位KB)。 |
status |
String |
镜像状态。枚举值如下:
|
status_message |
String |
镜像保存操作过程中,构建信息展示。 |
support_res_categories |
Array of strings |
镜像支持的规格。 枚举值如下:
|
swr_path |
String |
SWR镜像地址。 |
tag |
String |
镜像Tag。 |
type |
String |
镜像类型。枚举值如下:
|
update_at |
Long |
镜像最后更新的时间,UTC毫秒。 |
visibility |
String |
镜像可见度。枚举值如下:
|
workspace_id |
String |
工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
参数 |
参数类型 |
描述 |
---|---|---|
create_at |
Long |
实例创建的时间,UTC毫秒。 |
duration |
Long |
实例运行时长,以创建时间为起点计算,即“创建时间+duration > 当前时刻”时,系统会自动停止实例。 |
enable |
Boolean |
是否启用自动停止功能。 |
type |
String |
自动停止类别。
|
update_at |
Long |
实例最后更新(不包括探活心跳)的时间,UTC毫秒。 |
参数 |
参数类型 |
描述 |
---|---|---|
capacity |
Integer |
存储容量,EVS默认5G,EFS默认50G,最大限制4096G。 |
category |
String |
支持的存储类型。不同存储类型的差异,详见开发环境中如何选择存储。枚举值如下:
|
mount_path |
String |
存储挂载至Notebook实例的目录,当前固定在/home/ma-user/work/下。 |
ownership |
String |
资源所属,枚举值如下:
|
status |
String |
EVS扩容状态,扩容时的状态为RESIZING,此时实例可以正常使用。 |
请求示例
GET https://{endpoint}/v1/{project_id}/notebooks/all
响应示例
状态码: 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 |
错误码
请参见错误码。