文档

UpdateInstance - 更新实例

更新时间:

更新DSW实例的属性。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidsw:UpdatePostPaidInstanceupdate
  • 全部资源
    *

请求语法

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

请求参数

名称类型必填描述示例值
InstanceIdstring

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

dsw-730xxxxxxxxxx
bodyobject

需要更新的实例属性。

InstanceNamestring

实例名称。格式要求:

  • 只能包含英文字母、数字和下划线(_)。
  • 不能超过 27 个字符。
training_data
EcsSpecstring

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

ecs.c6.large
ImageIdstring

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

image-05cefd0be2exxxx
ImageUrlstring

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

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
Datasetsarray<object>

数据集集合。

Datasetobject

数据集对象。

DatasetIdstring

数据集 ID。如何获取数据集 ID,请参见 ListDatasets

d-vsqjvsjp4orp5l206u
MountPathstring

容器内挂载路径。

/mnt/data
Uristring

需要挂载的 OSS 目录的 Uri,使用时不能同时指定 DatasetId。

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

自定义数据集挂载属性,目前仅支持 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" }
OptionTypedeprecatedstring

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

ReadOnly
UserVpcobject

User VPC 配置。

VpcIdstring

VPC ID。

vpc-xxxxx
VSwitchIdstring

交换机 ID。

vsw-xxxxx
SecurityGroupIdstring

安全组 ID。

sg-xxxxxx
ExtendedCIDRsarray

扩展网段。

  • 当交换机 ID 为空时,此参数可以不提供,系统会自动获取 VPC 下的所有网段;
  • 当交换机 ID 不为空时,此参数必须提供,建议填写 VPC 下的所有网段。
ExtendedCIDRstring

扩展网段。

"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
DefaultRoutestring

默认路由。取值如下:

  • eth0:表示使用默认网卡,通过公共网关访问外部网络。
  • eth1:表示使用用户弹性网卡,通过私有网关访问外部网络。
eth0
ForwardInfosarray

Forward Infos

ForwardInfo
Accessibilitystring

工作空间内是否他人可见。取值如下:

  • PRIVATE:表示工作空间内自己及管理员可见。
  • PUBLIC:工作空间所有用户可见。
PRIVATE
DisassociateDatasetsboolean

是否删除关联数据集。

  • 打开开关:表示删除关联数据集。
  • 关闭开关:表示保留关联数据集。
false
DisassociateVpcboolean

是否删除关联用户 VPC。

false
DisassociateForwardInfosboolean

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

false
RequestedResourceobject

资源配置,弹内或者轻量化时使用。

CPUstring

CPU 核数。

32
Memorystring

内存大小,单位为 GB。

32
SharedMemorystring

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

32
GPUstring

GPU 数量。

4
GPUTypestring

GPU 显卡类型。

v100
WorkspaceSourcestring

工作空间指向的存储,如果不指定,则依次使用 NAS,CloudDisk 或者本地磁盘。

d-123456789
UserIdstring

实例的使用者,可能是子账号或者主账号。

16122**********
CloudDisksarray<object>

云盘列表

[]
CloudDiskobject
Capacitystring

云盘容量

30Gi
SubTypestring

云盘类型, rootfs 挂载为 rootfs

rootfs
Prioritylong

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

1 为最低优先级。 9 为最高优先级。

1
Driverstring

NVIDIA 驱动配置。

535.54.03
DisassociateDriverboolean

是否删除 NVIDIA 驱动配置。

false
CredentialConfigCredentialConfig

凭据配置

DisassociateCredentialboolean

是否删除 credential 注入信息

false
Affinityobject

亲和性配置。

CPUobject

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

Enableboolean

是否开启 CPU 亲和性。

true:开启。 false:不开启。

true
ImageAuthstring

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

****

返回参数

名称类型描述示例值
object

执行结果。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码,可能值:

  • 400
  • 404
null
InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-01API 内部配置变更,不影响调用查看变更详情
2024-07-09API 内部配置变更,不影响调用查看变更详情
2024-06-24API 内部配置变更,不影响调用查看变更详情
2024-01-09API 内部配置变更,不影响调用查看变更详情
2023-12-27API 内部配置变更,不影响调用查看变更详情
2023-12-14API 内部配置变更,不影响调用查看变更详情
2023-11-14API 内部配置变更,不影响调用查看变更详情
2023-08-09API 内部配置变更,不影响调用查看变更详情
2023-08-08API 内部配置变更,不影响调用查看变更详情
2023-03-28API 内部配置变更,不影响调用查看变更详情
2022-01-20OpenAPI 返回结构发生变更查看变更详情