AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 人工智能平台 PAI 开发参考 API参考 PAI-DSW API API目录 实例 UpdateInstance - 更新实例

UpdateInstance - 更新实例

更新时间：
产品详情
我的收藏
重要

本文中含有需要您注意的重要提示信息，忽略该信息可能对您的业务造成影响，请务必仔细阅读。

更新DSW实例的属性。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:UpdatePostPaidInstance

update

*全部资源

*

 无 无

请求语法

PUT /api/v2/instances/{InstanceId} HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

实例 ID。如何获取实例 ID，请参见 ListInstances 。

dsw-730xxxxxxxxxx
body

object

否

需要更新的实例属性。

InstanceName

string

否

实例名称。格式要求：

  • 只能包含英文字母、数字和下划线（_）。

  • 不能超过 27 个字符。

training_data
EcsSpec

string

否

实例对应的 ECS 规格。如何获取 ECS 规格，请参见 ListEcsSpecs 。

ecs.c6.large
ImageId

string

否

镜像 ID。如何获取镜像 ID，请参见 ListImages 。

image-05cefd0be2exxxx
ImageUrl

string

否

镜像地址。如何获取镜像地址，请参见 ListImages 。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
UserVpc

object

否

User VPC 配置。

VpcId

string

否

VPC ID。

vpc-xxxxx
VSwitchId

string

否

交换机 ID。

vsw-xxxxx
SecurityGroupId

string

否

安全组 ID。

sg-xxxxxx
ExtendedCIDRs

array

否

扩展网段。

  • 当交换机 ID 为空时，此参数可以不提供，系统会自动获取 VPC 下的所有网段；

  • 当交换机 ID 不为空时，此参数必须提供，建议填写 VPC 下的所有网段。

["192.168.0.1/24", "192.168.1.1/24"]

string

否

扩展网段。

"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
DefaultRoute

string

否

默认路由。取值如下：

  • eth0：表示使用默认网卡，通过公共网关访问外部网络。

  • eth1：表示使用用户弹性网卡，通过私有网关访问外部网络。

eth0
ForwardInfos

array

否

实例端口映射配置。

ForwardInfo

否

ForwardInfo。

BandwidthLimit

BandwidthLimit

否

Accessibility

string

否

实例的可见性。

枚举值：

  • PUBLIC :

    工作空间所有用户可见

  • PRIVATE :

    工作空间内自己及管理员可见

PRIVATE
Datasets

array

否

数据集列表。

object

否

数据集对象。

DatasetId

string

否

数据集 ID，当数据集为只读时，无法通过 MountAccess 将数据集改为读写。

如何获取数据集 ID，请参见 ListDatasets ，指定数据集 ID 时不能指定 Uri。

d-vsqjvs****rp5l206u
DatasetVersion

string

否

数据集版本，需同时指定 DatasetId，不填默认为 v1。

v1
Uri

string

否

存储服务目录的 Uri，实现直接挂载，该字段与 DatasetId 互斥。

不同类型存储的 Uri 格式详见：

  • OSS: oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/

  • NAS: nas://29**d-b12****446.cn-hangzhou.nas.aliyuncs.com/data/path/

  • 极速 NAS: nas://29****123-y**r.cn-hangzhou.extreme.nas.aliyuncs.com/data/path/

  • CPFS: cpfs://cpfs-213****87.cn-wulanchabu/ptc-292*****cbb/exp-290********03e/data/path/

  • 智算 CPFS: bmcpfs://cpfs-290******foflh-vpc-x****8r.cn-wulanchabu.cpfs.aliyuncs.com/data/path/

oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/
MountPath

string

否

数据集的挂载路径。

/mnt/data
MountAccess

string

否

数据集挂载后的读写权限，假如数据集是只读，无法修改为读写。

枚举值：

  • RW :

    读写

  • RO :

    只读

RW
Options

string

否

自定义数据集挂载属性，目前仅支持 OSS，使用时不能同时指定 OptionType，详见： DSW 挂载配置。

{ "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" }
OptionType deprecated

string

否

挂载类型，使用时不能同时指定 Options，目前已废弃，不建议使用，建议使用 Options 参数。

ReadOnly
Dynamic

boolean

否

是否开启动态挂载，默认为 false。

  • 目前只支持通用计算资源的实例。

  • 目前只支持 OSS 数据集，挂载后的数据集是只读模式。

  • 动态挂载数据集的 MountPath 必须是动态挂载根路径（默认为/mnt/dynamic/）的子路径（例如/mnt/dynamic/data1/)。

  • 动态挂载数据集必须位于非动态挂载数据集的后面。

false
DisassociateDatasets

boolean

否

是否删除关联数据集。

  • true：删除关联数据集。

  • false：保留关联数据集。

false
DisassociateVpc

boolean

否

是否删除关联用户 VPC。

false
DisassociateForwardInfos

boolean

否

是否删除关联端口透出信息

false
RequestedResource

object

否

资源配置。

{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}
CPU

string

否

CPU 核数。

32
Memory

string

否

内存大小，单位为 GB。

32
SharedMemory

string

否

共享内存大小，单位为 GB。

32
GPU

string

否

GPU 数量。

4
GPUType

string

否

GPU 显卡类型。

v100
WorkspaceSource

string

否

指定工作目录对应的存储，支持将云盘或 Datasets 中的数据集同时挂载到/mnt/workspace 工作目录，不支持 oss 数据集和动态挂载的数据集。

目前可以填写：

  • rootfsCloudDisk： 将云盘挂载到工作目录。

  • 数据集的挂载路径：Datasets 中数据集的 MountPath，如/mnt/data，uri 格式的数据集只支持通过该方式指定。

  • 数据集的 id，如 d-vsqjvs****rp5l206u，假如同一个数据集挂载到多个路径，会选择第一个，不建议使用该方式，建议使用挂载路径。

假如为空：

  • 假如实例使用了云盘，会默认选择云盘。

  • 假如没有云盘，会选择第一个 nas 或 cpfs 数据集作为工作目录。

  • 假如没有云盘，且没有 nas 或 cpfs 工作目录，会使用宿主机空间。

/mnt/data
UserId

string

否

实例的使用者 id。

16122**********
CloudDisks

array

否

云盘列表。

[]

object

否

Capacity

string

否

当资源类型选择公共资源，或当资源配额选择预付费通用计算资源（CPU 核数≥2 且内存≥4G，或配置 GPU）时：

每个实例会赠送 100 GiB 免费系统盘额度，用于持久化存储。如果实例停机超过 15 天，云盘的内容将被清空。云盘支持扩容，具体扩容价格以控制台界面为准。

警告

  • 扩容后不支持缩容，请按需操作扩容。

  • 扩容后整块系统盘（免费+付费），不再受到停机 15 天释放的限制，但会持续产生费用。

  • 实例删除，系统盘同步释放，删除前请确保必要数据备份。

如果您需要永久性存储，可以配置数据集挂载，或在存储路径挂载中添加 OSS、NAS、CPFS 路径。

100Gi
SubType

string

否

云盘类型：

  • rootfs：将挂载为系统盘，系统环境存储在磁盘上。

rootfs
Priority

integer

否

优先级，在分配资源给实例时，优先级越高的实例越优先。取值范围为 1~9。

  • 1 为最低优先级。

  • 9 为最高优先级。

1
Driver

string

否

NVIDIA 驱动配置。

535.54.03
DisassociateDriver

boolean

否

是否删除 NVIDIA 驱动配置。

false
CredentialConfig CredentialConfig

否

凭据配置。

DisassociateCredential

boolean

否

是否删除 credential 注入信息。

false
Affinity

object

否

亲和性配置。

CPU

object

否

CPU 亲和性配置，仅支持通用计算预付费实例。

Enable

boolean

否

是否开启 CPU 亲和性。

  • true：开启。

  • false：不开启。

true
ImageAuth

string

否

用户私有镜像的账号密码信息 base64 编码后的值，密码部分会被隐藏。

****
DynamicMount DynamicMount

否

动态挂载配置。

EnvironmentVariables

object

否

注入 DSW 实例的环境变量。

警告 这里传入的环境变量可能会覆盖系统预设的环境变量

{ "ENABLE_TRAIN": "true", "ENABLE_DEBUG":"false", "INSTANCE_ENV":"prod" }
DisassociateEnvironmentVariables

boolean

否

删除用户传入的环境变量。

false
UserCommand

object

否

用户自定义的执行命令。

OnStart

object

否

在每次实例启动时都会执行的自定义命令，执行时机是实例环境初始化之后，jupyter-lab、code-server 等服务启动之前。

Content

string

否

具体的自定义启动命令内容。

apt update && echo initialized
DisassociateUserCommand

boolean

否

删除用户指定的自定义命令。

false
OversoldType

string

否

闲时资源的类型

ForceQuotaOverSold：只使用闲时资源 AcceptQuotaOverSold：可接受闲时资源 ForbiddenQuotaOverSold：使用保障资源
DisassociateSpot

boolean

否

SpotSpec

object

否

SpotStrategy

string

否

SpotWithPriceLimit
SpotPriceLimit

string

否

0.12
SpotDuration

string

否

0
SpotDiscountLimit

string

否

0.1
DisassociateAssignNode

boolean

否

AssignNodeSpec

object

否

NodeNames

string

否

node-a
AntiAffinityNodeNames

string

否

node-b

返回参数

名称

类型

描述

示例值

object

执行结果。

RequestId

string

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Success

boolean

成功标志，可能值：

  • true

  • false

true
Message

string

返回结果说明。

"XXX"
Code

string

状态码，可能值：

  • InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。

  • ValidationError：参数验证错误。

null
HttpStatusCode

integer

HTTP 状态码，可能值：

  • 400

  • 404

null
InstanceId

string

实例 ID。

dsw-730xxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：DeleteInstance - 删除实例下一篇：StartInstance - 启动实例