更新Notebook实例
功能介绍
更新Notebook实例接口用于修改Notebook实例的配置信息,包括名称、描述、规格和镜像等。该接口适用于以下场景:用户需要调整Notebook实例的配置以适应新的需求时,可通过此接口更新实例的详细信息。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限,同时Notebook实例必须处于停止状态。调用该接口后,系统将更新指定Notebook实例的配置信息。若用户无权限操作指定实例或Notebook实例未停止,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或更新参数无效,接口将返回相应的错误提示。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/{project_id}/notebooks/{id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
参数解释:Notebook实例ID。ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID),可通过调用查询Notebook实例列表接口获取。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
参数解释:支持更新实例描述信息。 约束限制:不涉及。 取值范围:长度限制为512字符,且不能包含字符&<>"'/。 默认取值:不涉及。 |
endpoints |
否 |
Array of EndpointsReq objects |
参数解释:仅在本地IDE(如PyCharm、VS Code)或SSH客户端接入Notebook。 约束限制:仅在本地IDE(如PyCharm、VS Code)或SSH客户端,通过SSH远程接入Notebook实例时需要的相关配置。 |
flavor |
否 |
String |
参数解释:支持变更实例的机器规格。支持变更的规格可以通过本章节的查询支持可切换规格列表的API获取。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
image_id |
否 |
String |
参数解释:支持更新镜像ID,镜像ID参考查询支持的镜像列表获取。 约束限制:不涉及。 取值范围:调用查询支持的镜像列表接口获取的合法镜像ID列表。 默认取值:不涉及。 |
name |
否 |
String |
参数解释:支持更新实例名称。 约束限制:不涉及。 取值范围:长度限制为128个字符,支持大小写字母、数字、中划线和下划线,名称可重复。 默认取值:不涉及。 |
storage_new_size |
否 |
Integer |
参数解释:EVS实例支持动态扩充的容量,单位GB。只允许扩容,不允许缩容。 约束限制:不涉及。 取值范围:最大允许扩容至4096。 默认取值:不涉及。 |
hooks |
否 |
CustomHooks object |
参数解释:支持更新实例启动脚本。 约束限制:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
allowed_access_ips |
否 |
Array of strings |
参数解释:允许远程接入的公网IP地址列表,最多5个。 约束限制:不涉及。 |
service |
否 |
String |
参数解释:支持的服务。 约束限制:不涉及。 取值范围:枚举类型,取值如下:
默认取值:不涉及。 |
key_pair_names |
否 |
Array of strings |
参数解释:SSH密钥对名称,可以在云服务器控制台(ECS)“密钥对”页面创建和查看。 约束限制:不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释:计费资源类型。枚举类型,取值如下:
|
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 |
参数解释:指定镜像来源。 取值范围:枚举类型,取值如下:
|
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”,存在创建并使用的工作空间,以实际取值为准。 取值范围:不涉及。 |
flavor_type |
String |
参数解释:镜像的资源类型。 取值范围:枚举类型,取值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
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,此时实例可以正常使用。 取值范围:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
domain |
domain object |
参数解释:账号domain信息。 |
id |
String |
参数解释:IAM用户ID。获取方法请参见获取用户ID和名称。 取值范围:不涉及。 |
name |
String |
参数解释:IAM用户名。 取值范围:不涉及。 |
状态码:201
Created
请求示例
{ "description" : "update" }
响应示例
状态码:200
OK
{ "description" : "test", "flavor" : "modelarts.vm.cpu.8u", "name" : "notebook-1111", "endpoints" : [ { "allowed_access_ips" : [ "1.1.1.1" ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
201 |
Created |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。