CreateInstance - 创建实例

重要

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

调用CreateInstance创建一个DSW实例。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v2/instances HTTP/1.1

请求参数

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

实例属性。

WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

40823
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,当数据集为只读时,无法通过 MountAccess 将数据集改为读写。

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

d-vsqjvs****rp5l206u
DatasetVersionstring

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

v1
Uristring

存储服务目录的 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/
MountPathstring

数据集的挂载路径。

/mnt/data
MountAccessstring

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

RW
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
Dynamicboolean

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

  • 目前只支持通用计算资源的实例。
  • 目前只支持 OSS 数据集,挂载后的数据集是只读模式。
  • 动态挂载数据集的 MountPath 必须是动态挂载根路径(默认为/mnt/dynamic/)的子路径(例如/mnt/dynamic/data1/)。
  • 动态挂载数据集必须位于非动态挂载数据集的后面。
true
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
ForwardInfosarray

端口透出信息。

ForwardInfo

端口透出信息列表,可配置映射端口、网关 ID、SSH 公钥等参数。

Accessibilitystring

实例的可见性。

枚举值:
  • PUBLIC工作空间所有用户可见
  • PRIVATE工作空间内自己及管理员可见
PRIVATE
EnvironmentVariablesobject

环境变量。

string

用户指定环境变量,DSW 实例启动后,指定环境变量会被注入到容器中。

MAAS
ResourceIdstring

资源组 ID,预付费时配置。如何创建专有资源组,请参见准备及管理 DLC 资源组集群

dsw-123456789
Prioritylong

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

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

资源配置。

CPUstring

CPU 核数。

32
Memorystring

内存大小。单位为 GB。

32GB
SharedMemorystring

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

32GB
GPUstring

GPU 数量。

4
GPUTypestring

GPU 显卡类型,取值如下:

  • V100
  • A100
  • T4
  • A10
  • P100
v100
Labelsarray<object>

用户自定义标签。

{'foo': 'bar'}
Labelobject

用户定义标签。

Keystring

用户定义标签键。

stsTokenOwner
Valuestring

用户定义标签值。

123xxxxxxxx
CloudDisksarray<object>

云盘列表。

[]
CloudDiskobject

云盘列表。

Capacitystring

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

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

警告
  • 扩容后不支持缩容,请按需操作扩容。

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

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

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

    100Gi
    SubTypestring

    云盘类型:

    • rootfs:将挂载为系统盘,系统环境存储在磁盘上。
    rootfs
    MountPathstring

    云盘的挂载路径。

    /mnt/systemDisk
    Pathstring

    挂载到实例的云盘子路径。

    workspace
    Statusobject

    云盘或者快照使用情况。

    Availablelong

    可使用量,单位 Byte。

    31841058816
    Usagelong

    已使用量,单位 Byte。

    371195904
    Capacitylong

    容量,单位 Byte。

    32212254720
    WorkspaceSourcestring

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

    目前可以填写:

    • rootfsCloudDisk: 将云盘挂载到工作目录。
    • 数据集的挂载路径:Datasets 中数据集的 MountPath,如/mnt/data,uri 格式的数据集只支持通过该方式指定。
    • 数据集的 id,如 d-vsqjvs****rp5l206u,假如同一个数据集挂载到多个路径,会选择第一个,不建议使用该方式,建议使用挂载路径。

    假如为空:

    • 假如实例使用了云盘,会默认选择云盘。
    • 假如没有云盘,会选择第一个 nas 或 cpfs 数据集作为工作目录。
    • 假如没有云盘,且没有 nas 或 cpfs 工作目录,会使用宿主机空间。
    rootfsCloudDisk
    UserIdstring

    实例所有者的账号 ID。支持阿里云账号或 RAM 用户。

    161228528250****
    Driverstring

    NVIDIA 驱动配置。

    535.54.03
    CredentialConfigCredentialConfig

    凭据配置。

    Affinityobject

    亲和性配置信息。

    CPUobject

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

    Enableboolean

    是否开启 CPU 亲和性。

    • false:不开启。
    • true:开启。
    true
    ImageAuthstring

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

    ****
    DynamicMountDynamicMount

    动态挂载配置。

    Tagarray<object>

    Tag 列表。

    object

    Tag。

    Keystring

    Tag 的 key。

    tag1
    Valuestring

    Tag 的 Value。

    value1

    返回参数

    名称类型描述示例值
    object

    执行结果。

    RequestIdstring

    请求 ID。

    E7D55162-4489-1619-AAF5-3F97D5FCA948
    Successboolean

    成功标志,可能值:

    • true
    • false
    true
    Messagestring

    返回结果说明。

    "XXX"
    Codestring

    状态码,可能值:

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

    HTTP 状态码,可能值:

    • 400
    • 404
    • 200
    200
    InstanceIdstring

    实例 ID。

    dsw-730xxxxxxxxxx

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

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